Phone number orders
Endpoints
| Endpoint | Method | Description |
|---|---|---|
/v1/phone-number-orders | GET | List all orders |
/v1/phone-number-orders/{id} | GET | Get specific order |
List Orders
Endpoint
GET /v1/phone-number-ordersQuery Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | - | Filter: pending, success, failed |
verification_group_id | uuid | No | - | Filter by verification group |
number_type | string | No | - | Filter: local, mobile, national |
limit | integer | No | 20 | Maximum results (1-100) |
offset | integer | No | 0 | Pagination offset |
Example Request
Example Response
{
"data": [
{
"id": "660e8400-e29b-41d4-a716-446655440000",
"phone_number": "+31201234567",
"status": "pending",
"number_type": "local",
"requirements_met": true,
"ordered_at": "2025-01-15T10:30:00Z",
"verification_group": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Amsterdam Office",
"locality": "Amsterdam"
}
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0
}
}Get Order Details
Endpoint
GET /v1/phone-number-orders/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | uuid | Yes | Order ID |
Example Request
Example Response
{
"data": {
"id": "660e8400-e29b-41d4-a716-446655440000",
"phone_number": "+31201234567",
"status": "success",
"number_type": "local",
"requirements_met": true,
"ordered_at": "2025-01-15T10:30:00Z",
"external_order_id": "telnyx_order_123",
"external_sub_order_id": "telnyx_sub_456",
"verification_group": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Amsterdam Office",
"status": "approved",
"locality": "Amsterdam",
"phone_number_type": "local"
}
}
}Order Statuses
| Status | Description |
|---|---|
pending | Order is being processed |
success | Order completed, number is ready to use |
failed | Order failed (check verification group status) |
Response JSON Schema (List)
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"phone_number": { "type": "string" },
"status": { "type": "string", "enum": ["pending", "success", "failed"] },
"number_type": { "type": "string" },
"requirements_met": { "type": "boolean" },
"ordered_at": { "type": "string", "format": "date-time" },
"verification_group": {
"type": "object",
"nullable": true,
"properties": {
"id": { "type": "string", "format": "uuid" },
"name": { "type": "string", "nullable": true },
"locality": { "type": "string", "nullable": true }
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"total": { "type": "integer" },
"limit": { "type": "integer" },
"offset": { "type": "integer" }
}
}
}
}Response JSON Schema (Single Order)
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"phone_number": { "type": "string" },
"status": { "type": "string" },
"number_type": { "type": "string" },
"requirements_met": { "type": "boolean" },
"ordered_at": { "type": "string", "format": "date-time" },
"external_order_id": { "type": "string", "nullable": true },
"external_sub_order_id": { "type": "string", "nullable": true },
"verification_group": {
"type": "object",
"nullable": true,
"properties": {
"id": { "type": "string", "format": "uuid" },
"name": { "type": "string", "nullable": true },
"status": { "type": "string", "nullable": true },
"locality": { "type": "string", "nullable": true },
"phone_number_type": { "type": "string", "nullable": true }
}
}
}
}
}
}Once your order is complete, link the number to an assistant.
Modified at 2025-12-08 10:37:00