ELelevenlabs
smb
SMB

List Workspace Phone Assignments

Changed on

List the workspace's phone numbers and the receptionist each one rings. A number with no customer_facing_agent_id is held by the workspace but not attached to a receptionist yet.

get/v1/smb/phone-numbers/assignments

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/smb/phone-numbers/assignments
  • Auth
    none declared

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

xi-workspace-idstring nullable

The customer workspace a reseller's API key acts on.

Response

Successful Response

phone_numberstring
is_byoboolean

True when the phone is bring-your-own: registered by the workspace using their own telephony provider (Twilio credentials or SIP trunk). BYO phones are never part of the shared pool, do not count against the tier-based phone quota, and are deleted (rather than returned to the pool) on release.

provider'twilio' | 'sip_trunk'

Telephony provider for this phone number. Defaults to twilio for backwards compatibility with existing documents.

nanp_area_codeinteger

US/Canada NANP area code (NPA) as an integer.

customer_facing_agent_idstring nullable

Determines assignment status: None = pool (unassigned), non-None = assigned to this customer-facing agent. When set, inbound calls to this phone route to that agent.

deactivated_at_unixinteger nullable

Unix timestamp when this assignment was deactivated. Drives the per-assignment 14-day grace cleanup. None when active.

deactivation_reason'tier_downgrade' | 'no_entitlement' | 'user'

Why a phone assignment is currently inactive.

regulatory_status'held' | 'approved'

Regulatory standing of a number in a country that requires paperwork.

Absent (None) on numbers from countries with no requirements, which is every pooled US/Canada number — those are usable the moment they are bought.

regulatory_number_type'local' | 'mobile'

Which kind of regulated number a request or an issued number is for.

Lives here rather than next to the application model because a phone assignment records it too, and the assignment model cannot import from telephony.models without a cycle back into this module.

regulatory_countrystring
_idstring required
created_at_unixinteger

Unix timestamp (seconds since epoch)

updated_at_unixinteger

Unix timestamp (seconds since epoch)

is_activeboolean required
accepts_public_callsboolean required

Whether inbound calls from the public may reach the agent.

Changes