Phone Configuration
Phone Configuration manages telephony resources including phone numbers from various providers (SignalWire, Twilio). They track provider information, channel associations, and operational status.
Schema: PhoneConfigurationSchema
Source: src/core/service-configuration/phone-config.schema.ts
Attributes
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | — | — | Unique identifier for the phone configuration |
phoneNumber | string | Yes | — | Phone number, short code, or alphanumeric sender ID |
providerPhoneNumberId | string | Yes | — | Provider's unique identifier |
phoneRequestId | string | Yes | — | Reference ID for the original phone number request or setup configuration |
friendlyName | string | null | Yes | — | Human-readable display name |
regionId | string | null | No | — | Provider-specific region identifier |
monthlyPrice | number | null | No | — | Monthly recurring cost |
regionOrCountryName | string | null | No | — | Human-readable region/country name |
countryCode | string | No | — | ISO 3166-1 alpha-2 country code |
providerType | enum | No | SIGNALWIRE | Telephony service provider. One of SIGNALWIRE or TWILIO. |
isImported | boolean | No | false | Whether imported from external system |
status | enum | No | INACTIVE | Current operational status. One of PENDING, ACTIVE, INACTIVE, SUSPENDED, or RELEASED. |
isPorted | boolean | No | false | Whether ported from another provider |
markedForRelease | boolean | null | No | false | Whether marked for disconnection |
metadata | object | No | — | Provider-specific metadata |
voiceChannelId | string | null | No | — | Voice deployment channel ID |
smsChannelId | string | null | No | — | SMS deployment channel ID |
voiceChannel | DeploymentChannelInfo | null | No | — | Populated voice channel |
smsChannel | DeploymentChannelInfo | null | No | — | Populated SMS channel |
isUSSMSPermitted | boolean | No | false | US SMS messaging compliance flag |
createdAt | number | — | — | Unix timestamp when created |
updatedAt | number | — | — | Unix timestamp when last updated |
Example
{
"id": "phone_abc123",
"phoneNumber": "+12125551234",
"providerPhoneNumberId": "PN123abc",
"phoneRequestId": "REQ456",
"friendlyName": "Customer Support Line",
"regionId": "us-ny",
"monthlyPrice": 1.00,
"regionOrCountryName": "New York, United States",
"countryCode": "US",
"providerType": "SIGNALWIRE",
"status": "ACTIVE",
"isImported": false,
"isPorted": false,
"isUSSMSPermitted": true,
"createdAt": 1709856000000,
"updatedAt": 1709856000000
}
Update Schema
| Schema | Description |
|---|---|
UpdatePhoneConfigurationSchema | Only allows updating friendlyName |
Related
- Phone Number - Phone number purchase and discovery
- Interaction Channels - Uses phone configurations for call/SMS channels