API Reference · Phone numbers

List phone numbers

Returns every phone number in your company, newest first, with the AI employee that answers it and the account or SIP trunk it belongs to.

GET/phone-numbers

https://calling.ubiqproject.com/api/v1/phone-numbers · Auth: API key (full or read-only)

Request

No parameters. There is no pagination — every number is returned.

Request

curl https://calling.ubiqproject.com/api/v1/phone-numbers \
  -H "Authorization: Bearer vk_live_YOUR_KEY"

Response

An array of phone numbers.

Response · 200

[
  {
    "id": "a71d9e04-2c3b-4f58-8e6a-1b9c0d2e3f47",
    "number": "+918046801234",
    "provider": "sip",
    "name": "Collections line",
    "location": "Bengaluru",
    "agent_id": "3f8c2a1e-6b4d-4c7a-9e21-5d0f7b8a9c34",
    "agent_name": "Priya",
    "account_id": "c5e2b7a9-0d1f-4e36-b8c4-7a6f5e3d2c18",
    "account_label": "Tata SIP trunk",
    "webhook_configured": null,
    "webhook_detail": null
  },
  {
    "id": "f2b8c6d4-1e3a-4c7b-a9d5-6e0f2a4b8c13",
    "number": "+14155550142",
    "provider": "twilio",
    "name": "US support",
    "location": "San Francisco",
    "agent_id": null,
    "agent_name": null,
    "account_id": null,
    "account_label": null,
    "webhook_configured": null,
    "webhook_detail": null
  }
]

Response fields

idstring (UUID)

The phone number's ID.

numberstring

The number as stored. SIP numbers are always stored in international format (+91…).

providerstring

twilio, plivo, exotel or sip.

namestring | null

Your label for the number.

locationstring | null

Your note of the number's region or office.

agent_idstring | null

The AI employee that answers calls to this number. null if none.

agent_namestring | null

That AI employee's name.

account_idstring | null

The telephony account or SIP trunk the number belongs to. null means Daffy Voice's own account.

account_labelstring | null

That account's name.

webhook_configuredboolean | null

Only set right after adding a number or changing its account: whether Daffy Voice pointed the provider's incoming calls at your AI employee. Always null in lists.

webhook_detailstring | null

A sentence explaining webhook_configured.