frozenmountain/liveswitch-sip-connector

LiveSwitch SIP Connector 镜像文档

镜像概述和主要用途

LiveSwitch SIP Connector作为客户端应用与公共电话网络之间的桥梁，需配合SIP中继或PBX（专用交换机）使用，以实现呼入和呼出通话功能。它通过SIP协议实现通信连接，是LiveSwitch通信解决方案的重要组件。

核心功能和特性

• 充当客户端应用与公共电话网络的中间桥梁，实现通信连接
• 支持SIP信令传输，使用UDP或TCP协议的5060端口
• 需依赖SIP中继或PBX实现呼入和呼出通话能力
• 支持中继/PBX注册及通话流量处理

使用场景和适用范围

适用于需要将客户端应用与传统电话网络集成的场景，如企业通信系统、VoIP应用、客户服务平台等，需通过SIP中继或PBX实现公共电话网络接入的场景。

使用方法

快速启动

首先，需部署https://hub.docker.com/r/frozenmountain/liveswitch-gateway%E5%92%8Chttps://hub.docker.com/r/frozenmountain/liveswitch-media-server%E3%80%82

然后启动LiveSwitch SIP Connector镜像：

bash
sudo docker run -d \
    --env CONNECTIONSTRINGS:DEFAULT='postgres://postgres:password@postgres:5432/postgres' \
    --env CONNECTIONSTRINGS:CACHE='redis://redis' \
    --env SERVICEBASEURL='http://liveswitch-gateway:8080' \
    --network liveswitch \
    --publish 5060:5060 \
    --restart always \
    --name liveswitch-sip-connector \
      frozenmountain/liveswitch-sip-connector

关于CONNECTIONSTRINGS:DEFAULT和CONNECTIONSTRINGS:CACHE环境变量的详细说明见下文配置部分。

网络配置

• 端口5060：用于SIP信令传输，支持UDP和TCP协议。
  • UDP和TCP 5060端口处理中继/PBX注册及呼入/呼出通话的SIP流量。

配置说明

LiveSwitch SIP Connector的配置分为两个层级：

1. 实例配置：针对单个服务器的特定设置，通过环境变量或JSON配置文件完成
2. 部署配置：适用于所有服务器的全局设置，通过管理控制台或REST API完成

实例配置

推荐使用环境变量进行简单配置。如需使用JSON配置文件，文件必须位于/app/FM.LiveSwitch.Connector.Sip.Service.config.json，例如：

bash
docker cp FM.LiveSwitch.Connector.Sip.Service.config.json liveswitch-sip-connector:/app/FM.LiveSwitch.Connector.Sip.Service.config.json

JSON配置文件示例：

json
{
  "ConnectionStrings": {
    "Default": "postgres://postgres:password@postgres:5432/postgres",
    "Cache": "redis://127.0.0.1"
  },
  "Region": ""
}

环境变量名称与JSON属性名称的映射遵循.NET Core约定。

关键环境变量说明

• CONNECTIONSTRINGS:DEFAULT
  PostgreSQL连接URI，格式需符合https://github.com/ServiceStack/ServiceStack.Redis#redis-connection-strings%E8%A6%81%E6%B1%82%E3%80%82%E8%8B%A5%E6%9C%AA%E6%8F%90%E4%BE%9B%EF%BC%8C%E6%9C%8D%E5%8A%A1%E5%B0%86%E6%97%A0%E6%B3%95%E5%90%AF%E5%8A%A8%E3%80%82

• CONNECTIONSTRINGS:CACHE
  与https://github.com/ServiceStack/ServiceStack.Redis#redis-connection-strings%E5%85%BC%E5%AE%B9%E7%9A%84Redis%E8%BF%9E%E6%8E%A5%E5%AD%97%E7%AC%A6%E4%B8%B2%E3%80%82%E6%9C%AA%E6%8C%87%E5%AE%9A%E6%97%B6%E9%BB%98%E8%AE%A4%E5%80%BC%E4%B8%BA%60127.0.0.1%60%E3%80%82

• REGION
  字符串值，供LiveSwitch Gateway选择处理SIP通话的Media Server时使用。指定region的SIP Connector的呼入/呼出通话将优先匹配具有相同region值的Media Server。

部署配置

• 管理控制台：默认通过Gateway的:9090/admin访问，支持现代浏览器。
• REST API：默认通过Gateway的:9090/admin/api访问，遵循OData最佳实践，推荐使用v2 API进行配置的读写操作。
• REST API探索器：默认通过Gateway的:9090/admin/swagger访问，基于https://swagger.io/%EF%BC%8C%E6%94%AF%E6%8C%81%E5%9C%A8%E6%B5%8F%E8%A7%88%E5%99%A8%E4%B8%AD%E6%8E%A2%E7%B4%A2%E5%92%8C%E4%BA%A4%E4%BA%92API%E3%80%82