SIPHON logo

Telephony models & helpers

Telephony models & helpers

This page documents the small telephony helper classes and models used by Dispatch and Call.

SIPConfig (outbound)

Defined in siphon.telephony.outbound.make_call.

class SIPConfig(BaseModel):
    name: Optional[str]
    sip_address: str
    sip_number: str
    sip_username: str
    sip_password: str

How it’s used

  • Call(..., sip_trunk_setup=...) accepts either:
    • a dict (converted into SIPConfig), or
    • a SIPConfig instance

The fields map to your SIP provider credentials.

siphon.telephony.inbound.Trunk

Helper for inbound trunks.

from siphon.telephony.inbound import Trunk

Methods

  • create_trunk(name: Optional[str], sip_number: str) -> Dict[str, Any]
  • get_trunk(sip_number: str) -> Dict[str, Any]
  • get_trunk_by_id(trunk_id: str) -> Dict[str, Any]

Return dicts typically contain:

  • trunk_id
  • sip_number (for get_trunk_by_id)

siphon.telephony.outbound.Trunk

Helper for outbound trunks.

from siphon.telephony.outbound import Trunk

Methods

  • create_trunk(name: Optional[str], sip_address: str, sip_number: str, sip_username: str, sip_password: str) -> Dict[str, Any]
  • get_trunk(sip_address: str, sip_number: str, sip_username: str) -> Dict[str, Any]
  • get_trunk_by_id(trunk_id: str) -> Dict[str, Any]

Return dicts typically contain:

  • trunk_id
  • sip_number (for get_trunk_by_id)

See also