FreeSWITCH ESL协议的介绍和使用

FreeSWITCH简介

FreeSWITCH是一个开源的SIP软交换，可以通过SIP、WebRTC等方式接入实现语音、文本、视频等通信。可以接入传统的电话线路、IM、E1、PSTN中继线，也可以通过特制模块实现接入 Skype、QQ、微信等。

ESL简介

ESL (Event Socket Library) 是由FreeSWITCH的mod_event_socket模块提供的一个自定义协议，可通过此协议实现控制FreeSWITCH执行相关命令操作，例如: 外呼、通话桥接、通话放音等。也可以通过此模块监听FreeSWITCH在通话过程中分发的一些事件。例如在FreeSWITCH接收到呼叫指令时会创建通道，此时会产生通道创建的事件，通过ESL可以非常方便的监听并控制通话流程。

FreeSWITCH官方有提供一个esl的客户端。 下面是基于此客户端写的一个springboot starter。得益于springboot 的自动配置和依赖注入，该项目将使ESL开发变得格外简单!
Maven地址: https://mvnrepository.com/artifact/top.wdcc/eslclient-spring-boot-starter.
Gitee地址: https://gitee.com/Tangwego/eslclient-spring-boot-starter
Github地址: https://github.com/Tangwego/eslclient-spring-boot-starter
具体使用方法可参照 Gitee或者Github中的README.md

ESL协议格式和流程

esl是一个简单文本协议，类似HTTP
协议头主要包含两个字段:
一个是 content-type，一个是content-length。

• 首次连接后会收到一个 content-type为auth/request的响应，该协议提示我们要求进行认证， 此时我们应该使用 auth 密码\n\n指令进行认证，认证之后就可以发送命令了。
• 发送ESL命令会返回一个content-type为command/reply响应，通知命令是否执行成功。
• 当订阅事件后，会不断的给客户端推送订阅的相关事件，如果是订阅的plain格式会返回content-type为text/event-plain的事件。推送的事件类型有 text/event-plain、text/event-xml、text/event-json等三种，还有一种特殊的连接断开事件，会返回text/disconnect-notice。
• 最后一个类型是执行api指令的时候才会返，当使用api指令发送相关命令时会返content-type为api/response的响应而不是返 command/reply。