盒子

```
话机API 调用接口说明文档。
用websocket 与服务连接
地址：本机地址为 ws://127.0.0.1:8800/
```

### 2.1  通用
#### 2.1.1  发起LINK连接
>i  示例
```
功能：网页和中间件；USB和电脑的连接情况

web发给服务:
{"cmd":"LINK"}
服务发给web:
{"cmd":"LINK","success":true,"message":"成功"}
{"cmd":"USB","connected":false}

注：服务必须先收到link 指令后，服务才能主动给web 发消息。
```
#### 2.1.2  话机连接状态
>i  示例
```
功能：设备插入/拔出电脑连接成功，自动发送消息

服务发给web:
{"cmd":"USB","connected":true}
```
#### 2.1.3  拨号
>i  示例
```
功能：控制设备呼出电话

web 发给服务：
{"cmd":"ATD","number":"10010","callid":"123456"}
服务发给 web:
{"callId":"123456" ,"cmd":"ATD","message":"成功","number":"10010","success":true}

注：  callid：通话记录 id，未指定则设备自动生成callId 格式如下      production_out_10010_316320122        production_out_拨打号码_时间戳
```
#### 2.1.4  挂断
>i  示例
```
功能：控制设备挂断电话

web 发给服务：
{"cmd":"ATH"}
服务发给 web:
{"cmd":"ATH","success":true,"message":"成功"}
```
#### 2.1.5  接听
>i  示例
```
功能：控制设备接听电话

web 发给服务：
{"cmd":"ATA"}
服务发给 web：
{"cmd":"ATA","success":true,"message":"成功"}
```
#### 2.1.6  读取设备IMEI
>i  示例
```
功能：或者设备模组的IMEI号

web 发给服务：
{"cmd":"READIMEI"}
服务发给 web：
{"cmd":"READIMEI","imei":"86251xxxx12345","success":true,"message":"成功"}
```
#### 2.1.7  读取设备版本号
>i  示例
```
功能：控制设备接听电话

web 发给服务：
{"cmd":"READVER"}
服务发给 web：
{"cmd":"READVER","message":"成功","success":true,"ver":" CT_H2211_V1.0"}
```
#### 2.1.8  设备来电通知
>i  示例
```
功能: 设备收到呼入电话通知web端

服务发给 web：
{"cmd":"CALLING","number":"10010","success":true,"message":"成功"}
```
#### 2.1.9  设备去电振铃通知
>i  示例
```
功能: 设备主呼电话，对方振铃则反馈信息

服务发给 web：
{"cmd":"CORG","number":"10010","success":true,"message":"成功"}
```
#### 2.1.10  设备来电/去电接通通知
>i  示例
```
功能: 设备呼入或者呼出电话接通后通知web端

服务发给 web：
{"cmd":"CBEGIN","success":true,"message":"成功"}
```
#### 2.1.11  设备挂机返回
>i  示例
```
功能: 设备电话挂机后通知web端

服务发给 web：
{"cmd":"CEND","success":true,"message":"成功"}
```
#### 2.1.12  查询信号值
>i  示例
```
功能: 查询当前卡信号值

web 发给服务：
{"cmd":"GETCSQ"}
服务发给 web：
{"cmd":"GETCSQ","message":"成功","CSQ":"1"}
```
#### 2.1.13  查询ICCID
>i  示例
```
功能: 查询当前卡ICCID

web 发给服务：
{"cmd":"GETICCID"}
服务发给 web：
{"cmd":"GETICCID","iccid":"89860xxx19796502","message":"成功"}
```
#### 2.1.14  查询IMSI
>i  示例
```
功能: 查询当前卡IMSI

web 发给服务：
{"cmd":"GETIMSI"}
服务发给 web：
{"cmd":" GETIMSI ","imsi":" 4601xxxx124792 ","message":"成功"}
```
#### 2.1.15  查询本机号码
>i  示例
```
功能: 查询当前卡号码

web 发给服务：
{"cmd":"GETPHONENUM"}
服务发给 web：
{"cmd":" GETPHONENUM ","number":" 136xxxx00","message":"成功"}

注：有些SIM卡内未存储号码，所以number为空
```
#### 2.1.16  查询设备通话状态
>i  示例
```
功能: web端主动查询当前通话状态

web 发给服务：
{"cmd":"GETCallStat"}
服务发给 web：
{"cmd":"GETCallStat","message":"成功","CallStat":1,"number":"10010","callId":""}

注：CallStat: 0 -- 来电  1 -- 打电话对方未振铃  2 -- 对方振铃  3 -- 接通  5 -- 挂机
```
#### 2.1.17  拨DTMF号码
>i  示例
```
功能: 控制设备拨DTMF号码

web 发给服务：
{"cmd":"dtmf","number":"1"}
服务发给 web：
{"cmd":"dtmf","message":"成功"}
  
注：number: DTMF号码范围为 1,2,3,4,5,6,7,8,9,0,*,#
```
#### 2.1.18  设备重启
>i  示例
```
功能: 控制设备重启

web 发给服务：
{"cmd":"RESET" }
服务发给 web：
{"cmd":" RESET ","success":true,"message":"成功"}
```
#### 2.1.19  透传AT指令
>i  示例
```
功能: 透传AT指令给设备模组

web 发给服务：
{"cmd": "AT","buf":"AT+CNUM"}
服务发给 web：
{"cmd":" AT ","data":"AT+CNUM\r\n\r\nOK\r\n","success":true,"message":"成功"}
```
#### 2.1.20  查询当前卡座信息
>i  示例
```
功能: 获取当前设备使用卡座序号和卡ICCID

web 发给服务：
{"cmd": "GETSIMINDEX"}
服务发给 web：
{"cmd":" GETSIMINDEX ","value":"1","iccid":"89860xxxxx96502","success":true,"message":"成功"}
```
#### 2.1.21  切换卡座
>i  示例
```
功能: 获取当前设备使用卡座序号和卡ICCID

web 发给服务：
{"cmd": "SETSIMINDEX","value": "1"}
服务发给 web：
{"cmd":" SETSIMINDEX ","success":true,"message":"成功"}

注：value: 1/2/3/4
```
#### 2.1.22  配置通话记录和录音上传地址
>i  示例
```
功能: 对接平台，将通话记录和录音文件上传到第三方平台

web 发给服务：
{"cmd": "setCallrecord","pid": 123432,"userWid":"34356",
"callrecordUrl":"https://api.xxx.cn/zq/xxx ",
"recordFileUrl":"https://api.xxxx.cn/zq/xxx"}

服务发给 web：
{"cmd":"setCallrecord",success":true,"message":"成功"}

注：value: 1/2/3/4 
    pid：企业 id
userWid：员工 id

```
callrecordUrl：上传通话记录 url，设置了上报通话记录。
传输数据是 application/json utf-8，http post，格式如下：

| 参数名称 | 必选 | 类型 | 说明 |
| --- | --- | --- | --- |
|IMEI	|	|String|	话机唯一标识|
|pid	|	|Long	|企业 id|
|userWid	|	|Long	|员工 id|
|caller	|	|String|	主叫号码|
|callee|	|	String|	被叫号码|
|callId	|	|String	|通话唯一 id|
|callDirection|		|byte|	呼叫类型；0 呼入，1 呼出|
|callFlag	|	|byte	|接听标志；0：未接听，1：已接听|
|duration	|	|int|	通话时长，从接听开始，单位秒|
|startTime|		|long|	通话开始时间：【去电 --  接通时间 、来电 --  振铃时间】|
|endTime	|	|long|	通话结束时间|
|deviceType	|	|byte	|2：全网通，3：标准版,目前只有 2|

>i  示例
```
示例数据：
	{
	"type": "calllog",
	"conte nt": {
		"IMEI": "86671xxx4909397",
		"pid": 3021,
		"userWi d": 762,
		"caller": "+8617xxxx11",
		"callee": "1364xxxx11",
		"callId": "production_out_136xxx68_166xxxx00",
		"callDirecti on": 1,
		"callFlag": 1,
		"duration": 4,
		"startTime": 1668695362000,
		"endTime": 1668695366000,
		"deviceType": 2
	}
}
```
recordFileUrl：上传录音文件的 url
传输数据是 form 表单，http post，格式如下：

| 参数名称 | 必选 | 类型 | 说明 |
| --- | --- | --- | --- |
| callId | 是 | String | 通话唯一 id，与通话记录的callid 一致. |
| recordFile | 是 | File | 录音文件，文件内容 |
| IMEI | 是 | String | 话机唯一标识 |
| pid | 是 | Long | 企业 id |
>i  示例
```
示例数据：

{
	"callId ": "dedefef",
	"recordFile": file,
	"IMEI": "dedefef",
	"pid": 123432
}
```
#### 2.1.23  接收短信
>i  示例
```
功能: 主动上报收到的短消息

服务发给 web：
{"cmd":"REV_MSG","Time":"23/03/20,20:23:13","PhoneNum":"+8613xxxx10","Content ":"你好"}
```
#### 2.1.24  发送短信
>i  示例
```
功能: 主动上报收到的短消息
web 发给服务：
{"cmd": "SEND_MSG","PhoneNum":"10086","Content": "你好"}

服务发给 web：
{"cmd":" SEND_MSG ","success":true}
```
#### 2.1.25  模块锁定/解锁
>i  示例
```
功能: 锁定/解锁 模块
web 发给服务：
{"cmd":"LOCK","value":"0"}

注:   value : 0  锁定模块
1解锁模块
2查询状态

服务发给 web：
{"cmd":"LOCK","success":true,"state":"unlock","message":"成功"}
```
#### 2.1.26  获取基站位置信息
>i  示例
```
功能: 锁定/解锁 模块
web 发给服务：
{"cmd":"GETLOCATION"}

服务发给 web：
{"cmd":"GETLOCATION","success":true,"mcc":"460","mnc":"01","lac":"1888","ci":"0D6285E","message":"成功"}
 
 注：获取到基站信息后，可参考高德、百度 智能设备定位接口，传入参数获取基站的经纬度信息。
测试网页如图
```

![](/media/202406/图片1_1718770966.png)

[【附件】盒子.zip](/media/attachment/2024/06/%E7%9B%92%E5%AD%90.zip)