Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Phone Numbers
  • Platform
    • Users
      • List Users
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
      • Create User
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
    • SMS
      • Get SMS Conversations
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. Phone Numbers

Phone Numbers

POST
https://platform-api.convirza.com/v3/phone-numbers/order
Phone Numbers
Last modified:2026-04-03 14:27:57
Orders one or more numbers through supported providers and reserves them in local inventory. Note: This endpoint only purchases/reserves numbers. SMS/MMS capabilities must be configured separately via SPAPI2 microservice.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Order operation completed
Body

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://platform-api.convirza.com/v3/phone-numbers/order' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_numbers": [
        {
            "number": "+14255551212",
            "source": 10001
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "code": 200,
    "message": "Success",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-26T18:00:00.000Z",
    "data": {
        "total": 2,
        "success_count": 1,
        "error_count": 1,
        "data": [
            {
                "number": "+14255551212",
                "message": "Number ordered successfully"
            }
        ]
    }
}
Modified at 2026-04-03 14:27:57
Previous
Reserved Numbers
Next
Available Numbers
Built with