Azure Communication Services: Phonenumbers
The phone numbers client uses Azure Communication Services to purchase and manage phone numbers.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The phone numbers client uses Azure Communication Services to purchase and manage phone numbers.
Endpoints 20
Browse for available countries, cities and area codes
- GETGets the list of available area codes.
/availablePhoneNumbers/countries/:countryCode/areaCodes?phoneNumberType=geographic&skip=0&maxPageSize=100&assignmentType=person&locality=string&administrativeDivision=string&api-version=string - GETGets the list of supported countries.
/availablePhoneNumbers/countries?skip=0&maxPageSize=100&api-version=string - GETGets the list of cities or towns with available phone numbers.
/availablePhoneNumbers/countries/:countryCode/localities?skip=0&maxPageSize=100&administrativeDivision=string&api-version=string&phoneNumberType=geographic - GETList available offerings of capabilities with rates for the given country.
/availablePhoneNumbers/countries/:countryCode/offerings?skip=0&maxPageSize=100&phoneNumberType=geographic&assignmentType=person&api-version=string
Browse, reserve and purchase available phone numbers
- POSTBrowses for available phone numbers to purchase.
/availablePhoneNumbers/countries/:countryCode/:browse?api-version=stringBrowses for available phone numbers to purchase. The response will be a randomized list of phone numbers available to purchase matching the browsing criteria.… - GETLists all reservations.
/availablePhoneNumbers/reservations?api-version=string&maxPageSize=100Retrieves a paginated list of all phone number reservations. Note that the reservations will not be populated with the phone numbers associated with them. - GETGets a reservation by its ID.
/availablePhoneNumbers/reservations/:reservationId?api-version=stringRetrieves the reservation with the given ID, including all of the phone numbers associated with it. - DELETEDeletes a reservation by its ID.
/availablePhoneNumbers/reservations/:reservationId?api-version=stringDeletes the reservation with the given ID. Any phone number in the reservation will be released and made available for others to purchase. Only reservations… - PATCHCreates or updates a reservation by its ID.
/availablePhoneNumbers/reservations/:reservationId?api-version=stringAdds 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… - POSTStarts the purchase of all phone numbers in the reservation.
/availablePhoneNumbers/reservations/:reservationId/:purchase?api-version=stringStarts 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…
Find and purchase available phone numbers
- POSTSearch for available phone numbers to purchase.
/availablePhoneNumbers/countries/:countryCode/:search?api-version=string - GETGets a phone number search result by search id.
/availablePhoneNumbers/searchResults/:searchId?api-version=string - POSTPurchases phone numbers.
/availablePhoneNumbers/:purchase?api-version=string
Long running operations
- GETGets an operation by its id.
/phoneNumbers/operations/:operationId?api-version=string - DELETECancels an operation by its id.
/phoneNumbers/operations/:operationId?api-version=string
Manage purchased phone numbers
- PATCHUpdates the capabilities of a phone number.
/phoneNumbers/:phoneNumber/capabilities?api-version=string - GETGets the details of the given purchased phone number.
/phoneNumbers/:phoneNumber?api-version=string - DELETEReleases a purchased phone number.
/phoneNumbers/:phoneNumber?api-version=string - GETGets the list of all purchased phone numbers.
/phoneNumbers?skip=0&top=100&api-version=string
Obtain operator information for requested numbers
- POSTSearches for number format and operator information for a given list of phone numbers.
/operatorInformation/:search?api-version=string
API details
- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 20 operations on 16 pathsGET 10POST 5DELETE 3PATCH 2
- Main resources
- Browse, reserve and purchase available phone numbers 6Browse for available countries, cities and area codes 4Manage purchased phone numbers 4Find and purchase available phone numbers 3Long running operations 2Obtain operator information for requested numbers 1
- Description format
- Swagger 2.0, API version
2025-06-01 - Links
- OpenAPI document
How to test the Azure Communication Services: Phonenumbers in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Communication Services: Phonenumbers collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the list of available area codes.” (GET /availablePhoneNumbers/countries/:countryCode/areaCodes?phoneNumberType=geographic&skip=0&maxPageSize=100&assignmentType=person&locality=string&administrativeDivision=string&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Communication Services: Phonenumbers?
The phone numbers client uses Azure Communication Services to purchase and manage phone numbers. It is listed under Communication and has 20 endpoints.
Who publishes the Azure Communication Services: Phonenumbers?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure Communication Services: Phonenumbers?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Communication Services: Phonenumbers have?
20 operations on 16 paths (10 GET, 5 POST, 3 DELETE, 2 PATCH). The largest groups are Browse, reserve and purchase available phone numbers, Browse for available countries, cities and area codes, Manage purchased phone numbers, Find and purchase available phone numbers.
Is forking the Azure Communication Services: Phonenumbers free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.