Skip to main content
List Numbers
curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/numbers/searchNumbers \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "status": 200,
  "data": [
    {
      "number": "+919876543210",
      "sms_enabled": false,
      "voice_enabled": true
    },
    {
      "number": "+918765432109",
      "sms_enabled": false,
      "voice_enabled": true
    }
  ],
  "page": 1,
  "totalPages": 1,
  "totalCount": 2,
  "message": "Found Available Phone Numbers"
}

​
Headers

​
Authorization
string
required
Bearer token for authentication (e.g., Bearer <your_token>).

​
Query Parameters

​
provider
string
default:"timepay"
Telephony provider alias name.
​
country_iso
string
default:"IN"
Two-letter ISO country code.
​
limit
integer
default:10
Maximum number of results to return.
​
page
integer
default:1
The page number for pagination.
​
prefix
string
Limited support: Pattern or prefix to search for within the phone numbers.

​
Response

​
success
boolean
Indicates if the request was successful.
​
status
integer
HTTP status code of the response.
​
data
array
List of available phone numbers.
​
page
integer
The current page number (returned for Vobiz and Plivo).
​
totalPages
integer
Total number of pages available.
​
totalCount
integer
Total number of available numbers matching the query.
​
message
string
Descriptive response message.
{
  "success": true,
  "status": 200,
  "data": [
    {
      "number": "+919876543210",
      "sms_enabled": false,
      "voice_enabled": true
    },
    {
      "number": "+918765432109",
      "sms_enabled": false,
      "voice_enabled": true
    }
  ],
  "page": 1,
  "totalPages": 1,
  "totalCount": 2,
  "message": "Found Available Phone Numbers"
}