PhoneNumbersClient (stable:2025-04-01)

2025/03/31 • 20 new methods

PhoneNumbers_ListAreaCodes (new)
Description :  Gets the list of available area codes.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/countries/{countryCode}/areaCodes
{
countryCode:
{
Description: The ISO 3166-2 country code, e.g. US. ,
Required: True ,
}
string ,
phoneNumberType:
{
Description: Filter by numberType, e.g. Geographic, TollFree. ,
Required: True ,
}
string ,
skip:
{
Description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPageSize:
{
Description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
assignmentType:
{
Description: Filter by assignmentType, e.g. Person, Application. ,
Required: False ,
}
string ,
locality:
{
Description: The name of locality or town in which to search for the area code. This is required if the number type is Geographic. ,
Required: False ,
}
string ,
administrativeDivision:
{
Description: The name of the state or province in which to search for the area code. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
accept-language:
{
Description: The locale to display in the localized fields in the response. e.g. 'en-US' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
areaCodes:
{
Description: Represents a list of available toll-free area codes. ,
Required: True ,
}
[
{
areaCode:
{
Description: An area code. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Represents the URL link to the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_ListAvailableCountries (new)
Description :  Gets the list of supported countries.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/countries
{
skip:
{
Description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPageSize:
{
Description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
accept-language:
{
Description: The locale to display in the localized fields in the response. e.g. 'en-US' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
countries:
{
Description: Represents the underlying list of countries. ,
Required: False ,
}
[
{
localizedName:
{
Description: Represents the name of the country. ,
Required: True ,
}
string ,
countryCode:
{
Description: Represents the abbreviated name of the country. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Represents the URL link to the next page ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_BrowseAvailableNumbers (new)
Description :  Browses for available phone numbers to purchase. The response will be a randomized list of phone numbers available to purchase matching the browsing criteria. This operation is not paginated. Since the results are randomized, repeating the same request will not guarantee the same results.
Reference :  Link ¶

⚼ Request

POST:  /availablePhoneNumbers/countries/{countryCode}/:browse
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
countryCode:
{
Description: The ISO 3166-2 country code, e.g. US. ,
Required: True ,
}
string ,
phoneNumbersBrowseRequest:
{
Description: An object defining the criteria to browse for available phone numbers. ,
Required: True ,
}
{
phoneNumberType:
{
Description: Represents the number type of the offering. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: The minimum desired capabilities for the browse operation request. ,
Required: False ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
assignmentType:
{
Description: Represents the assignment type of the offering. Also known as the use case. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: False ,
}
enum ,
phoneNumberPrefixes:
{
Description: The phone number prefix to match. If specified, the search will be limited to phone numbers that start with the any of the given prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
phoneNumbers:
{
Description: The phone numbers that are available for purchase. ,
Required: True ,
}
[
{
id:
{
Description: The id of the phone number. ,
Required: False ,
}
string ,
countryCode:
{
Description: The ISO 3166-2 country code, e.g. US. ,
Required: True ,
}
string ,
phoneNumber:
{
Description: The phone number in E.164 format, e.g. +11234567890. ,
Required: False ,
}
string ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
phoneNumberType:
{
Description: Represents the number type of the offering. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
assignmentType:
{
Description: Represents the assignment type of the offering. Also known as the use case. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
cost:
{
Description: The incurred cost for this phone number. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the phone number. Possible values include: 'available', 'reserved', 'expired', 'error', 'purchased'. ,
Enum:
{
available: No description available. ,
reserved: No description available. ,
expired: No description available. ,
error: No description available. ,
purchased: No description available. ,
}
,
Required: False ,
}
enum ,
isAgreementToNotResellRequired:
{
Description: Indicates if do not resell agreement is required. If true, the phone number cannot be acquired unless the customer provides explicit agreement to not resell it. ,
Required: False ,
}
boolean ,
error:
{
Description: Contains error details in case of failure when reserving, releasing or purchasing the phone number. Note that this is ignored by the service when present in requests. ,
Required: False ,
}
{
code:
{
Description: The error code indicating the reason why the operation performed on the phone number failed. ,
Required: False ,
}
string ,
message:
{
Description: The error message describing the failure that occurred. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_ListAvailableLocalities (new)
Description :  Gets the list of cities or towns with available phone numbers.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/countries/{countryCode}/localities
{
countryCode:
{
Description: The ISO 3166-2 country code, e.g. US. ,
Required: True ,
}
string ,
skip:
{
Description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPageSize:
{
Description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
administrativeDivision:
{
Description: An optional parameter for the name of the state or province in which to search for the area code. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
accept-language:
{
Description: The locale to display in the localized fields in the response. e.g. 'en-US' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
phoneNumberLocalities:
{
Description: Represents the underlying list of localities, e.g. cities or town. ,
Required: False ,
}
[
{
localizedName:
{
Description: Represents the localized name of the locality. ,
Required: True ,
}
string ,
administrativeDivision:
{
Description: Represents an administrative division. e.g. state or province. ,
Required: False ,
}
{
localizedName:
{
Description: Represents the localized name of the administrative division of the locality. e.g. state or province localized name. ,
Required: True ,
}
string ,
abbreviatedName:
{
Description: Represents the abbreviated name of the administrative division of the locality. e.g. state or province abbreviation such as WA (Washington). ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Represents the URL link to the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_ListOfferings (new)
Description :  List available offerings of capabilities with rates for the given country.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/countries/{countryCode}/offerings
{
countryCode:
{
Description: The ISO 3166-2 country code, e.g. US. ,
Required: True ,
}
string ,
skip:
{
Description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPageSize:
{
Description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
phoneNumberType:
{
Description: Filter by numberType, e.g. Geographic, TollFree. ,
Required: False ,
}
string ,
assignmentType:
{
Description: Filter by assignmentType, e.g. Person, Application. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
accept-language:
{
Description: The locale to display in the localized fields in the response. e.g. 'en-US' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
phoneNumberOfferings:
{
Description: Represents the underlying list of offerings. ,
Required: False ,
}
[
{
phoneNumberType:
{
Description: Represents the number type of the offering. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: False ,
}
enum ,
assignmentType:
{
Description: Represents the assignment type of the offering. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: False ,
}
enum ,
availableCapabilities:
{
Description: Capabilities of a phone number. ,
Required: False ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
cost:
{
Description: The incurred cost for a single phone number. ,
Required: True ,
}
{
amount:
{
Description: The cost amount. ,
Format: double ,
Required: True ,
}
number ,
currencyCode:
{
Description: The ISO 4217 currency code for the cost amount, e.g. USD. ,
Required: True ,
}
string ,
billingFrequency:
{
Description: The frequency with which the cost gets billed. ,
Enum:
{
monthly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Represents the URL link to the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_ListReservations (new)
Description :  Retrieves a paginated list of all phone number reservations. Note that the reservations will not be populated with the phone numbers associated with them.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/reservations
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
maxPageSize:
{
Description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
reservations:
{
Description: Represents a list of phone numbers reservations. Note that the phone numbers from each reservation are not included. ,
Required: True ,
}
[
{
id:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: False ,
}
string ,
expiresAt:
{
Description: The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase. ,
Format: date-time ,
Required: False ,
}
string ,
phoneNumbers:
{
Description: A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'. ,
Enum:
{
active: No description available. ,
submitted: No description available. ,
completed: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: Represents the URL link to the next page of phone number results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_CreateOrUpdateReservation (new)
Description :  Adds and removes phone numbers from the reservation with the given ID. The response will be the updated state of the reservation. Phone numbers can be reserved by including them in the payload. If a number is already in the reservation, it will be ignored. To remove a phone number, set it explicitly to null in the request payload. This operation is idempotent. If a reservation with the same ID already exists, it will be updated, otherwise a new one is created. Only reservations with 'active' status can be updated. Updating a reservation will extend the expiration time of the reservation to 15 minutes after the last change, up to a maximum of 2 hours from creation time. Partial success is possible, in which case the response will have a 207 status code.
Reference :  Link ¶

⚼ Request

PATCH:  /availablePhoneNumbers/reservations/{reservationId}
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
reservationId:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: True ,
}
string ,
reservation:
{
Description: A representation of the desired state of the reservation. ,
Required: True ,
}
{
id:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: False ,
}
string ,
expiresAt:
{
Description: The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase. ,
Format: date-time ,
Required: False ,
}
string ,
phoneNumbers:
{
Description: A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'. ,
Enum:
{
active: No description available. ,
submitted: No description available. ,
completed: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: False ,
}
string ,
expiresAt:
{
Description: The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase. ,
Format: date-time ,
Required: False ,
}
string ,
phoneNumbers:
{
Description: A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'. ,
Enum:
{
active: No description available. ,
submitted: No description available. ,
completed: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (200)

{
id:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: False ,
}
string ,
expiresAt:
{
Description: The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase. ,
Format: date-time ,
Required: False ,
}
string ,
phoneNumbers:
{
Description: A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'. ,
Enum:
{
active: No description available. ,
submitted: No description available. ,
completed: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (207)

{
id:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: False ,
}
string ,
expiresAt:
{
Description: The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase. ,
Format: date-time ,
Required: False ,
}
string ,
phoneNumbers:
{
Description: A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'. ,
Enum:
{
active: No description available. ,
submitted: No description available. ,
completed: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_GetReservation (new)
Description :  Retrieves the reservation with the given ID, including all of the phone numbers associated with it.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/reservations/{reservationId}
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
reservationId:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: False ,
}
string ,
expiresAt:
{
Description: The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase. ,
Format: date-time ,
Required: False ,
}
string ,
phoneNumbers:
{
Description: A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections. ,
Required: False ,
}
object ,
status:
{
Description: Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'. ,
Enum:
{
active: No description available. ,
submitted: No description available. ,
completed: No description available. ,
expired: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_DeleteReservation (new)
Description :  Deletes the reservation with the given ID. Any phone number in the reservation will be released and made available for others to purchase. Only reservations with 'active' status can be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /availablePhoneNumbers/reservations/{reservationId}
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
reservationId:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_PurchaseReservation (new)
Description :  Starts a long running operation to purchase all of the phone numbers in the reservation. Purchase can only be started for active reservations that at least one phone number. If any of the phone numbers in the reservation is from a country where reselling is not permitted, do not resell agreement is required. The response will include an 'Operation-Location' header that can be used to query the status of the operation.
Reference :  Link ¶

⚼ Request

POST:  /availablePhoneNumbers/reservations/{reservationId}/:purchase
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
reservationId:
{
Description: The id of the reservation. ,
Format: uuid ,
Required: True ,
}
string ,
reservationPurchaseRequest:
{
Required: False ,
}
{
agreeToNotResell:
{
Description: The agreement to not resell the phone numbers. Defaults to false if not provided. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: URL to query for status of the operation. ,
}
string ,
operation-id:
{
Description: The operation id. ,
}
string ,
reservation-purchase-id:
{
Description: The reservation purchase operation id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_SearchAvailablePhoneNumbers (new)
Description :  Search for available phone numbers to purchase.
Reference :  Link ¶

⚼ Request

POST:  /availablePhoneNumbers/countries/{countryCode}/:search
{
countryCode:
{
Description: The ISO 3166-2 country code, e.g. US. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
body:
{
Description: The phone number search request. ,
Required: True ,
}
{
phoneNumberType:
{
Description: The type of phone numbers to search for, e.g. geographic, or tollFree. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
assignmentType:
{
Description: The assignment type of the phone numbers to search for. A phone number can be assigned to a person, or to an application. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
areaCode:
{
Description: The area code of the desired phone number, e.g. 425. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of desired phone numbers. The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
operation-location:
{
Description: URL to query for status of the operation. ,
}
string ,
operation-id:
{
Description: The operation id. ,
}
string ,
search-id:
{
Description: The search operation id. ,
}
string ,
}
,
$schema:
{
Description: The result of a phone number search operation. ,
}
{
searchId:
{
Description: The search id. ,
Required: True ,
}
string ,
phoneNumbers:
{
Description: The phone numbers that are available. Can be fewer than the desired search quantity. ,
Required: True ,
}
[
string ,
]
,
phoneNumberType:
{
Description: The phone number's type, e.g. geographic, or tollFree. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
assignmentType:
{
Description: Phone number's assignment type. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
cost:
{
Description: The incurred cost for a single phone number. ,
Required: True ,
}
{
amount:
{
Description: The cost amount. ,
Format: double ,
Required: True ,
}
number ,
currencyCode:
{
Description: The ISO 4217 currency code for the cost amount, e.g. USD. ,
Required: True ,
}
string ,
billingFrequency:
{
Description: The frequency with which the cost gets billed. ,
Enum:
{
monthly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
searchExpiresBy:
{
Description: The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z. ,
Format: date-time ,
Required: True ,
}
string ,
isAgreementToNotResellRequired:
{
Description: Indicates if do not resell agreement is required. If true, the phone numbers cannot be acquired unless the customer provides explicit agreement to not resell them. ,
Required: False ,
}
boolean ,
errorCode:
{
Description: The error code of the search. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Mapping Error Messages to Codes ,
Enum:
{
NoError: No description available. ,
UnknownErrorCode: No description available. ,
OutOfStock: No description available. ,
AuthorizationDenied: No description available. ,
MissingAddress: No description available. ,
InvalidAddress: No description available. ,
InvalidOfferModel: No description available. ,
NotEnoughLicenses: No description available. ,
NoWallet: No description available. ,
NotEnoughCredit: No description available. ,
NumbersPartiallyAcquired: No description available. ,
AllNumbersNotAcquired: No description available. ,
ReservationExpired: No description available. ,
PurchaseFailed: No description available. ,
BillingUnavailable: No description available. ,
ProvisioningFailed: No description available. ,
UnknownSearchError: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_GetSearchResult (new)
Description :  Gets a phone number search result by search id.
Reference :  Link ¶

⚼ Request

GET:  /availablePhoneNumbers/searchResults/{searchId}
{
searchId:
{
Description: The search Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
searchId:
{
Description: The search id. ,
Required: True ,
}
string ,
phoneNumbers:
{
Description: The phone numbers that are available. Can be fewer than the desired search quantity. ,
Required: True ,
}
[
string ,
]
,
phoneNumberType:
{
Description: The phone number's type, e.g. geographic, or tollFree. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
assignmentType:
{
Description: Phone number's assignment type. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
cost:
{
Description: The incurred cost for a single phone number. ,
Required: True ,
}
{
amount:
{
Description: The cost amount. ,
Format: double ,
Required: True ,
}
number ,
currencyCode:
{
Description: The ISO 4217 currency code for the cost amount, e.g. USD. ,
Required: True ,
}
string ,
billingFrequency:
{
Description: The frequency with which the cost gets billed. ,
Enum:
{
monthly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
searchExpiresBy:
{
Description: The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z. ,
Format: date-time ,
Required: True ,
}
string ,
isAgreementToNotResellRequired:
{
Description: Indicates if do not resell agreement is required. If true, the phone numbers cannot be acquired unless the customer provides explicit agreement to not resell them. ,
Required: False ,
}
boolean ,
errorCode:
{
Description: The error code of the search. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: Mapping Error Messages to Codes ,
Enum:
{
NoError: No description available. ,
UnknownErrorCode: No description available. ,
OutOfStock: No description available. ,
AuthorizationDenied: No description available. ,
MissingAddress: No description available. ,
InvalidAddress: No description available. ,
InvalidOfferModel: No description available. ,
NotEnoughLicenses: No description available. ,
NoWallet: No description available. ,
NotEnoughCredit: No description available. ,
NumbersPartiallyAcquired: No description available. ,
AllNumbersNotAcquired: No description available. ,
ReservationExpired: No description available. ,
PurchaseFailed: No description available. ,
BillingUnavailable: No description available. ,
ProvisioningFailed: No description available. ,
UnknownSearchError: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_PurchasePhoneNumbers (new)
Description :  Purchases phone numbers.
Reference :  Link ¶

⚼ Request

POST:  /availablePhoneNumbers/:purchase
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
body:
{
Description: The phone number purchase request ,
Required: True ,
}
{
searchId:
{
Description: The search id. ,
Required: False ,
}
string ,
agreeToNotResell:
{
Description: The agreement to not resell the phone numbers. Defaults to false if not provided. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: URL to query for status of the operation. ,
}
string ,
operation-id:
{
Description: The operation id. ,
}
string ,
purchase-id:
{
Description: The purchase operation id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_GetOperation (new)
Description :  Gets an operation by its id.
Reference :  Link ¶

⚼ Request

GET:  /phoneNumbers/operations/{operationId}
{
operationId:
{
Description: The id of the operation ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Url to retrieve the final result after operation completes. ,
}
string ,
}
,
$schema:
{
operationType:
{
Description: The type of operation, e.g. Search ,
Enum:
{
purchase: No description available. ,
releasePhoneNumber: No description available. ,
search: No description available. ,
updatePhoneNumberCapabilities: No description available. ,
reservationPurchase: No description available. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: Status of operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
}
,
Required: True ,
}
enum ,
resourceLocation:
{
Description: URL for retrieving the result of the operation, if any. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The date that the operation was created. ,
Format: date-time ,
Required: True ,
}
string ,
error:
{
Description: The Communication Services error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
id:
{
Description: Id of operation. ,
Required: True ,
}
string ,
lastActionDateTime:
{
Description: The most recent date that the operation was changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_CancelOperation (new)
Description :  Cancels an operation by its id.
Reference :  Link ¶

⚼ Request

DELETE:  /phoneNumbers/operations/{operationId}
{
operationId:
{
Description: The id of the operation ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_UpdateCapabilities (new)
Description :  Updates the capabilities of a phone number.
Reference :  Link ¶

⚼ Request

PATCH:  /phoneNumbers/{phoneNumber}/capabilities
{
phoneNumber:
{
Description: The phone number id in E.164 format. The leading plus can be either + or encoded as %2B, e.g. +11234567890. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
body:
{
Description: Defines the update capabilities request. ,
Required: False ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: False ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: URL to retrieve the final result after operation completes. ,
}
string ,
operation-location:
{
Description: URL to query for status of the operation. ,
}
string ,
operation-id:
{
Description: The operation id. ,
}
string ,
capabilities-id:
{
Description: The capabilities operation id. ,
}
string ,
}
,
$schema:
{
Description: Represents a purchased phone number. ,
}
{
id:
{
Description: The id of the phone number, e.g. 11234567890. ,
Required: True ,
}
string ,
phoneNumber:
{
Description: String of the E.164 format of the phone number, e.g. +11234567890. ,
Required: True ,
}
string ,
countryCode:
{
Description: The ISO 3166-2 code of the phone number's country, e.g. US. ,
Required: True ,
}
string ,
phoneNumberType:
{
Description: The phone number's type, e.g. geographic, tollFree. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
assignmentType:
{
Description: The assignment type of the phone number. A phone number can be assigned to a person, or to an application. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
purchaseDate:
{
Description: The date and time that the phone number was purchased. ,
Format: date-time ,
Required: True ,
}
string ,
cost:
{
Description: The incurred cost for a single phone number. ,
Required: True ,
}
{
amount:
{
Description: The cost amount. ,
Format: double ,
Required: True ,
}
number ,
currencyCode:
{
Description: The ISO 4217 currency code for the cost amount, e.g. USD. ,
Required: True ,
}
string ,
billingFrequency:
{
Description: The frequency with which the cost gets billed. ,
Enum:
{
monthly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_GetByNumber (new)
Description :  Gets the details of the given purchased phone number.
Reference :  Link ¶

⚼ Request

GET:  /phoneNumbers/{phoneNumber}
{
phoneNumber:
{
Description: The purchased phone number whose details are to be fetched in E.164 format, e.g. +11234567890. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the phone number, e.g. 11234567890. ,
Required: True ,
}
string ,
phoneNumber:
{
Description: String of the E.164 format of the phone number, e.g. +11234567890. ,
Required: True ,
}
string ,
countryCode:
{
Description: The ISO 3166-2 code of the phone number's country, e.g. US. ,
Required: True ,
}
string ,
phoneNumberType:
{
Description: The phone number's type, e.g. geographic, tollFree. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
assignmentType:
{
Description: The assignment type of the phone number. A phone number can be assigned to a person, or to an application. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
purchaseDate:
{
Description: The date and time that the phone number was purchased. ,
Format: date-time ,
Required: True ,
}
string ,
cost:
{
Description: The incurred cost for a single phone number. ,
Required: True ,
}
{
amount:
{
Description: The cost amount. ,
Format: double ,
Required: True ,
}
number ,
currencyCode:
{
Description: The ISO 4217 currency code for the cost amount, e.g. USD. ,
Required: True ,
}
string ,
billingFrequency:
{
Description: The frequency with which the cost gets billed. ,
Enum:
{
monthly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_ReleasePhoneNumber (new)
Description :  Releases a purchased phone number.
Reference :  Link ¶

⚼ Request

DELETE:  /phoneNumbers/{phoneNumber}
{
phoneNumber:
{
Description: Phone number to be released, e.g. +11234567890. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: URL to query for status of the operation. ,
}
string ,
operation-id:
{
Description: The operation id. ,
}
string ,
release-id:
{
Description: The release operation id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_ListPhoneNumbers (new)
Description :  Gets the list of all purchased phone numbers.
Reference :  Link ¶

⚼ Request

GET:  /phoneNumbers
{
skip:
{
Description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
phoneNumbers:
{
Description: Represents a list of phone numbers. ,
Required: True ,
}
[
{
id:
{
Description: The id of the phone number, e.g. 11234567890. ,
Required: True ,
}
string ,
phoneNumber:
{
Description: String of the E.164 format of the phone number, e.g. +11234567890. ,
Required: True ,
}
string ,
countryCode:
{
Description: The ISO 3166-2 code of the phone number's country, e.g. US. ,
Required: True ,
}
string ,
phoneNumberType:
{
Description: The phone number's type, e.g. geographic, tollFree. ,
Enum:
{
geographic: No description available. ,
tollFree: No description available. ,
}
,
Required: True ,
}
enum ,
capabilities:
{
Description: Capabilities of a phone number. ,
Required: True ,
}
{
calling:
{
Description: Capability value for calling. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
sms:
{
Description: Capability value for SMS. ,
Enum:
{
none: No description available. ,
inbound: No description available. ,
outbound: No description available. ,
inbound+outbound: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
assignmentType:
{
Description: The assignment type of the phone number. A phone number can be assigned to a person, or to an application. ,
Enum:
{
person: No description available. ,
application: No description available. ,
}
,
Required: True ,
}
enum ,
purchaseDate:
{
Description: The date and time that the phone number was purchased. ,
Format: date-time ,
Required: True ,
}
string ,
cost:
{
Description: The incurred cost for a single phone number. ,
Required: True ,
}
{
amount:
{
Description: The cost amount. ,
Format: double ,
Required: True ,
}
number ,
currencyCode:
{
Description: The ISO 4217 currency code for the cost amount, e.g. USD. ,
Required: True ,
}
string ,
billingFrequency:
{
Description: The frequency with which the cost gets billed. ,
Enum:
{
monthly: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Represents the URL link to the next page of phone number results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
PhoneNumbers_OperatorInformationSearch (new)
Description :  Searches for number format and operator information for a given list of phone numbers.
Reference :  Link ¶

⚼ Request

POST:  /operatorInformation/:search
{
api-version:
{
Description: Version of API to invoke ,
Required: True ,
}
string ,
body:
{
Description: The phone number(s) whose number format and operator information should be searched ,
Required: True ,
}
{
phoneNumbers:
{
Description: Phone number(s) whose operator information is being requested ,
Required: True ,
}
[
string ,
]
,
options:
{
Description: Represents options to modify a search request for operator information ,
Required: False ,
}
{
includeAdditionalOperatorDetails:
{
Description: Includes the fields operatorDetails, numberType, and isoCountryCode in the response. Please note: use of this option will result in additional costs ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
values:
{
Description: Results of a search. This array will have one entry per requested phone number which will contain the relevant operator information. ,
Required: False ,
}
[
{
phoneNumber:
{
Description: E.164 formatted string representation of the phone number ,
Required: True ,
}
string ,
nationalFormat:
{
Description: National format of the phone number ,
Required: False ,
}
string ,
internationalFormat:
{
Description: International format of the phone number ,
Required: False ,
}
string ,
isoCountryCode:
{
Description: ISO 3166-1 two character ('alpha-2') code associated with the phone number. ,
Required: False ,
}
string ,
numberType:
{
Description: Type of service associated with the phone number ,
Enum:
{
unknown: No description available. ,
other: No description available. ,
geographic: No description available. ,
mobile: No description available. ,
}
,
Required: False ,
}
enum ,
operatorDetails:
{
Description: Represents metadata describing the operator of a phone number ,
Required: False ,
}
{
name:
{
Description: Name of the phone operator ,
Required: False ,
}
string ,
mobileNetworkCode:
{
Description: Mobile Network Code, 2 or 3 decimal digits that identify mobile networks within a country/region ,
Required: False ,
}
string ,
mobileCountryCode:
{
Description: Mobile Country Code, 3 decimal digits that identify a country/region ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The inner error if any. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}