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": "timepay_v2"
}
]'
{
"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!"
}
Numbers Management
Buy Numbers
Purchase one or more available phone numbers from telephony providers and register them to your organization.
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": "timepay_v2"
}
]'
{
"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
403 Forbidden
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
Bearer <your_token>).string
Optional. Use this header only when the authenticated user belongs to multiple organizations. It identifies the organization to target for this action.
Body Parameters
The request body should be an array of objects representing the numbers to purchase.array[]
required
Response
boolean
Indicates if the request was processed successfully.
array
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": "timepay_v2"
}
]'
{
"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!"
}
Error Codes
| Status | Description |
|---|---|
400 | Validation error or invalid phone-number purchase request |
401 | Unauthorized - missing or invalid authorization header |
403 | Forbidden - insufficient permission to perform this action |
500 | Internal server error |