Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.helpgenie.ai/llms.txt

Use this file to discover all available pages before exploring further.

Manage phone numbers provisioned via Twilio for voice agents. Phone numbers can be assigned to genies for inbound and outbound calling.
Standard users can only view phone numbers assigned to their own agents. Admin users can view all phone numbers across the platform.

​
List phone numbers

Returns a paginated list of phone numbers with user profile enrichment.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "all" or "list".
​
data
object
​
success
boolean
​
data
object
curl -s https://api.helpgenie.ai/v1/phone-numbers \
  -H "Authorization: Bearer hg_live_YOUR_KEY"

​
Get phone number

Retrieves a single phone number by ID with profile enrichment.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "get".
​
id
string
required
The phone number record ID.

​
Stats

Returns aggregated statistics across phone numbers.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "stats".
​
data
object

​
Export

Exports phone numbers as a CSV string. Supports the same filters as the list action.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "export".
CSV columns: Phone Number, Friendly Name, Genie Name, User Email, User Name, Country, Status, Type, Date Provisioned. Maximum 10,000 records.

​
Provision

Provisions a new phone number via Twilio and assigns it to a genie. Delegates to the twilio-handler edge function.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "provision".
​
data
object
required

​
Release

Releases a provisioned phone number. Delegates to the twilio-handler edge function.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "release".
​
id
string
required
The phone number record ID to release.
This will release the phone number from Twilio. The number may become unavailable for re-provisioning.

​
Update

Updates phone number configuration. Delegates to the twilio-update-number edge function.
​
resource
string
required
Must be "phone-numbers".
​
action
string
required
Must be "update".
​
id
string
required
The phone number record ID to update.