Buy Numbers - timepay.ai

curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/numbers/buyNumbers \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "number": "919876543210",
    "provider": "plivo"
  }
]'

{
  "success": true,
  "data": [
    {
      "number": "919876543210",
      "success": true,
      "error": null
    }
  ]
}

{
  "success": false,
  "message": "Phone Numbers are required!"
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Missing or invalid authorization header"
}

{
  "success": false,
  "message": "Unexpected error at server. Please try again!"
}

curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/numbers/buyNumbers \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "number": "919876543210",
    "provider": "plivo"
  }
]'

{
  "success": true,
  "data": [
    {
      "number": "919876543210",
      "success": true,
      "error": null
    }
  ]
}

{
  "success": false,
  "message": "Phone Numbers are required!"
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Missing or invalid authorization header"
}

{
  "success": false,
  "message": "Unexpected error at server. Please try again!"
}

Headers

string

required

Bearer token for authentication (e.g., Bearer <your_token>).

Body Parameters

The request body should be an array of objects representing the numbers to purchase.

array[]

required

List of numbers to purchase.

Show item properties

string

required

The phone number to purchase.

string

required

Telephony provider alias name.

Show options

eg. timepay, timepay_v2 ..more

Response

boolean

Indicates if the request was processed successfully.

array

List of results for each requested number.

Show item properties

string

The phone number that was processed.

boolean

Indicates if the purchase of this specific number succeeded.

string

Error message if the purchase failed, or null if successful.

curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/numbers/buyNumbers \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "number": "919876543210",
    "provider": "plivo"
  }
]'

{
  "success": true,
  "data": [
    {
      "number": "919876543210",
      "success": true,
      "error": null
    }
  ]
}

{
  "success": false,
  "message": "Phone Numbers are required!"
}

{
  "success": false,
  "error": "Unauthorized",
  "message": "Missing or invalid authorization header"
}

{
  "success": false,
  "message": "Unexpected error at server. Please try again!"
}

​Headers

​Body Parameters

​Response

Headers

Body Parameters

Response