Skip to main content
🔐 Bundle plugin only: This is exclusive to the Video, Audio & Live Bundle. Get the bundle plugin here.

​
Fields

FieldTypeDescription
area codeTextAn areacode to search within.
regionTextA region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. CA for California. Cannot be used in combination with areacode.
cityTextA specific City to search within. Example, New York. Must be used in combination with region. Cannot be used with areacode, starts_with, contains, or ends_with.
containsTextA string of 3 to 7 digits that should appear somewhere in the number.
start withTextA string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.
ends withTextA string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.
⚠️ Important Notes:
  • Enter either an area code or a region—using both will result in an error.
  • To use the city field, you must also enter a region.
  • Pick one field: contains, starts with, or ends with—using more than one will cause an error.

​
Returned Values

FieldTypeDescription
phone numbersText (list)List of available phone numbers matching the criteria.
errorBooleanIndicates if an error occurred during the request.
error messageTextDescription of any error that occurred.
error statusNumberNumeric error status code.

Need Help?

View our options for free community and priority support.