Numbers | Sinch (1.0.3)
The Numbers API enables you to search for, buy, view, and manage numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling. Once you have bought your numbers, you can then use the various other APIs, such as SMS or Voice, to assign and use those numbers.
Use the Number Order API to buy numbers. It supports numbers from all regions and of all number types, and it collects any registration (KYC) information and supporting documents a region requires:
- Check what the region and number type require ("Lookup number requirements").
- Find a number to buy ("Search for available phone numbers" in the Available Numbers API), or skip this step and order by criteria instead.
- Create the order, provide any required registration information and documents, and submit it.
For a step-by-step walkthrough, see Ordering numbers that meet specific requirements.
Deprecated: The Available Numbers activation endpoints, "Activate a new phone number" (availableNumbers/{phoneNumber}:rent) and "Rent any number that matches the criteria" (availableNumbers:rentAny), are deprecated and only support US LOCAL numbers. They remain available for existing integrations, but new integrations should use the Number Order API. The Available Numbers search endpoints aren't deprecated and work for all regions and number types.
Only phone numbers in E.164 standard format are accepted by the API.
A summary of status codes can be found on the HTTP status codes page.
New features might result in additional request and response parameters. New request parameters will either have a default value or be considered optional to retain backwards compatibility. It's highly recommended to ignore any unexpected parameters when reading JSON in API responses and in callback handlers.