Want to provide feedback?

Write to docs@telesign.com.

Get Started with the Phone Numbers API

This page includes requirements and service details common to using any method of this API. Other pages provide details for individual methods.

Restrictions by Country

A phone number is subject to different regulatory compliance rules depending on the associated country. Within each country, rules may also differ by number type. These rules may require address and identity validation or impose specific service limitations. Be sure to observe all regulatory compliance rules when obtaining phone numbers through TeleSign.

TeleSign can assist you in completing any required validation documents and pass them on your behalf to the appropriate regulatory body. Contact your Customer Success Manager if you need additional help obtaining numbers for countries with regulatory restrictions.

Request

Base URL

https://rest-ww.telesign.com/v1/phone_numbers

Authentication

Basic (easiest to implement) or Digest

Encoding

Accepts only UTF-8 unicode characters as inputs.

Request Type

application/x-www-form-urlencoded

Required Headers

Content-Type - application/x-www-form-urlencoded

Resources

/numbers

Interact with TeleSign’s available number inventory.

Actions for this Resource:

  • Search for a Phone Number - Learn how to use the Phone Numbers API to search for a phone number that has your desired attributes.

/leases

Obtain and manage phone numbers from TeleSign.

Actions for this Resource:

  • Create a Lease - Learn how to use the Phone Numbers API to lease a specified phone number.
  • List Your Leased Numbers - Learn how to use the Phone Numbers API to retrieve a list of the phone numbers you have leased.
  • Cancel a Lease - Learn how to use the Phone Numbers API to cancel the lease of a specified phone number.

/direct_orders

Initiate and manage direct orders for phone numbers from TeleSign.

Actions for this Resource:

  • Create a Direct Order - Learn how to use the Phone Numbers API to place a direct order for one or more phone numbers, even in cases where a search returns no available phone numbers.
  • Get the Status of a Direct Order - Learn how to use the Phone Numbers API to retrieve the status of a specified direct order and to track its progress.
  • List Your Direct Orders - Learn how to use the Phone Numbers API to retreive a list of all previously created direct orders, including the status for each.
  • Cancel a Direct Order - Learn how to use the Phone Numbers API to cancel a specified direct order.

Response

Response Type

application/json