Interface ISipTrunkCarrier

What a SIP-trunk carrier implements. Deliberately narrow: describe, validate, report health, optionally list numbers.

interface ISipTrunkCarrier {
    Name: string;
    CheckHealth(context: SipTrunkValidationContext): Promise<SipTrunkHealth>;
    DescribeTrunk(): SipTrunkDescription;
    ListNumbers?(): Promise<SipTrunkNumber[]>;
    ValidateConfig(context: SipTrunkValidationContext): SipTrunkConfigCheck;
}

Implemented by

TwilioElasticSipTrunkCarrier

Index

Properties

Methods

CheckHealth DescribeTrunk ListNumbers? ValidateConfig

Properties

`Readonly`Name

Name: string

A stable identifier (twilio-elastic-sip).

Methods

CheckHealth

CheckHealth(context: SipTrunkValidationContext): Promise<SipTrunkHealth>
Reports health. An implementation that does not contact the carrier says so in SipTrunkHealth.Detail.
Parameters
- context: SipTrunkValidationContext
Returns Promise<SipTrunkHealth>
- Defined in packages/TelephonyAdapters/src/telephony/sipTrunkCarrier.ts:67

DescribeTrunk

DescribeTrunk(): SipTrunkDescription
The settings the carrier's trunk needs so it talks to LiveKit SIP.

Returns SipTrunkDescription
- Defined in packages/TelephonyAdapters/src/telephony/sipTrunkCarrier.ts:63

`Optional`ListNumbers

ListNumbers?(): Promise<SipTrunkNumber[]>
The numbers the carrier terminates for the deployment, when it can say.

Returns Promise<SipTrunkNumber[]>
- Defined in packages/TelephonyAdapters/src/telephony/sipTrunkCarrier.ts:69

ValidateConfig

ValidateConfig(context: SipTrunkValidationContext): SipTrunkConfigCheck
Checks the settings MJ holds for this carrier.
Parameters
- context: SipTrunkValidationContext
Returns SipTrunkConfigCheck
- Defined in packages/TelephonyAdapters/src/telephony/sipTrunkCarrier.ts:65