PhoneNumber
A carrier number attached to the Organization and its routing to an Agent (1.22.0, FR-telephony-2). Every Call on it is live: there are no test Phone numbers (api.md section 3).
An object with 15 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
agent_id | AgentId or null | yes | The Agent that inbound Calls to the number run (1.22.0). Null when the number routes to no Agent: every inbound Call to it is then refused and recorded with the ended reason refused_no_route. |
agent_version | integer or null | yes | The published version of the Agent that every inbound Call to the number runs, or null to run the Agent's active version as it stands when each Call is admitted. (1.22.0) |
capabilities | array of PhoneNumberCapability | yes | What the number may carry, each capability once (1.22.0). |
created_at | Timestamp | yes | |
display | string | yes | The number masked: the country calling code, a space-separated elision and the last four digits, such as +1 ... 2486, the form of a Call's destination_hint (1.22.0). Show it wherever the full number is not needed. |
e164 | string | yes | The full number in E.164 form (1.22.0). Only the routes that need telephony:read answer a Phone number, so only a holder of that permission receives it. It is never logged and never written to an Audit event. |
id | PhoneNumberId | yes | |
inbound_media_encryption | SipMediaEncryption or null | no | The media encryption the inbound LiveKit SIP trunk holds now (1.34.0), read-only: an operator changes it by provisioning again, never through the api. Null when the api could not read the trunk; a reader treats its absence as null, as from an api before 1.34.0. |
object | "phone_number" | yes | |
outbound_media_encryption | SipMediaEncryption or null | no | The media encryption the number's outbound trunk holds now (1.34.0), read-only. Null when the number has no outbound trunk, which a number without the outbound capability does not, or when the api could not read it; a reader treats its absence as null. |
outbound_transport | SipTransport or null | no | The SIP transport the number's outbound trunk holds now (1.34.0), read-only; null as outbound_media_encryption is. The inbound trunk has none, because the carrier chooses it. |
revision | integer | yes | Counts writes to the Phone number (1.22.0); returned as the ETag and required in the If-Match of the update. |
sip_trunk_id | SipTrunkId | yes | The SIP trunk the number is reached on (1.22.0). |
status | PhoneNumberStatus | yes | |
updated_at | Timestamp | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.