Python: Provision a Number & Route to Your AI Agent

Example based on the supplied API reference: whitelist the sending server IP, authenticate with the fixed initial x-auth-token, switch to the generated session x-auth-token, list available DIDs, assign one, and configure forwarding to a trunk IP.

import requests

BASE = "https://newsip.pbxme.com"

# Before calling the API, whitelist this server's source IP
# in the user's PBXMe account portal.
INITIAL_HEADERS = {
    "x-auth-token": "YOUR_INITIAL_X_AUTH_TOKEN",
    "Content-Type": "application/json"
}

# ── Step 1: Login with the fixed initial x-auth-token ───────
login = requests.post(
    f"{BASE}/api/login/",
    headers=INITIAL_HEADERS,
    json={
        "username": "YOUR_ACCOUNT_NUMBER",
        "password": "YOUR_PASSWORD"
    }
)
login.raise_for_status()

login_data = login.json()
account_id = login_data["id"]
token = login_data["account_token"]
session_x_auth_token = login_data["x-auth-token"]

# Use the generated session x-auth-token after Login.
SESSION_HEADERS = {
    "x-auth-token": session_x_auth_token,
    "Content-Type": "application/json"
}

# ── Step 2: List available DIDs ─────────────────────────────
# country_id is the optional numeric country ID provided in the Country List reference/example.
available = requests.post(
    f"{BASE}/customer/did_crud/",
    headers=SESSION_HEADERS,
    json={
        "action": "available_list",
        "parent_id": "0",
        "country_id": "YOUR_COUNTRY_ID",
        "id": account_id,
        "token": token
    }
)

print("Available DIDs:", available.json())

# ── Step 3: Assign a DID ────────────────────────────────────
# Replace with a did_id returned by DID Available List.
did_id = "YOUR_DID_ID"

assign = requests.post(
    f"{BASE}/customer/did_management/",
    headers=SESSION_HEADERS,
    json={
        "action": "assign",
        "did_id": did_id,
        "accountid": account_id,
        "reseller_id": "0",
        "id": account_id,
        "token": token
    }
)

print("Assigned:", assign.json())

# ── Step 4: Configure forwarding toward your AI telephony stack ──
# The supplied API reference example uses call_type=2 and a trunk IP.
forward = requests.post(
    f"{BASE}/customer/did_management/",
    headers=SESSION_HEADERS,
    json={
        "action": "forward",
        "did_id": "YOUR_PURCHASED_DID_ID",
        "call_type": "2",
        "call_type_value": "YOUR_TRUNK_IP",
        "always": "5",
        "user_busy": "5",
        "user_not_registered": "5",
        "no_answer": "5",
        "extensions": "",
        "call_type_vm_flag": "",
        "always_destination": "",
        "always_vm_flag": "",
        "user_busy_destination": "",
        "user_busy_vm_flag": "",
        "user_not_registered_destination": "",
        "user_not_registered_vm_flag": "",
        "no_answer_destination": "",
        "no_answer_vm_flag": "",
        "id": account_id,
        "token": token
    }
)

print("Forwarding configured:", forward.json())