话机盒子接口文档

接口文档

接口描述

简要描述：

本接口描述话机盒子接口的使用方法和协议规范。

请求域名:

http://dapi.wei-fu.cn

接口说明:

接口采用 json + http 模式，请求和响应数据均为 utf-8 编码的 json 格式
请求内容包含：请求消息体
响应内容为 json 字符串
请求方式：post
请求示例：

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "imei": "xxx",
    "code": "xxx",
}

公共参数说明:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证，签名生成规则请查看下方介绍

code签名:

imei: 话机的唯一值
code：签名认证
签名认证规则为：
MD5（时间戳+话机ID）+MD5(话机ID+年月日时分秒+KEY)+"-"+MD5（时间戳）
如：
KEY=”123456abc”，
imei =“abcd6542tye”
时间戳 = 1703051387 时间戳转为年月日时分秒： 20231220134947
code = md5(1703051387abcd6542tye) + md5(abcd6542tye20231220134947123456abc) + "-" + md5（1703051387）
最终 code = 6fb9361f6bd934ae93ef2ee73381fba6e0175d5ba7970ef4a8b021e6d778406d-b361208b5b26d82ced6b836b3436a944

设备注册接口

设备在插电之后，需要向系统发送验证请求，在系统上注册设备号

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/activation.php

请求方式:

POST

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
phone	是	string	设备的电话号码

请求示例:

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "imei": "xxx",
    "code": "xxx",
    "phone":"xxx"
}

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/activation.php' -H 'Content-Type: application/josn;charset=utf-8' -d '{"imei": "2013122000001","code": "ee07a4f4a9bddd18205e5fa13f5fa3f04345918b477efcdcbaa5154ba5f67393-617df8fbb4cf202423406b6c972d6f7e","phone": "135xxxx"}'

返回示例:

正确时返回:

{
    "msg": "ok",
    "action": "",
    "code": "",
}

错误时返回:

{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "电话号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型
code	string	签名认证

心跳接口

该接口用检测设备是否在线以及设备执行的指令，接口带有返回值，返回有详细的说明，

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/heartbeat.php

请求方式:

POST

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
phone	是	string	设备的电话号码

请求示例:

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "imei": "xxx",
    "code": "xxx",
	"phone":"xxx"
}

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/heartbeat.php' -H 'Content-Type: application/josn;charset=utf-8' -d '{"imei": "2013122000001","code": "022281ecacf4a6fef6b1992b0f406f8c1d653348ea50a92e6b381f2eac7a53e6-c9866b22bc851025b3cc37c0f15fef25","phone": "135xxxxx"}'

返回示例:

正确时返回:


{
    "msg": "ok",
    "action": "",
    "code": "6588ff487dd5bd14547315978efcdf8190c2bf3e7f4a6f02e42006639c3478f5-429e592773a82bef65b68803a78fd42d",
    "data": []
}


发送呼叫指令
{
    "msg": "ok",
    "action": "call",
    "code": "3de0df79280b4037566d7e37c120e6436b418da6a866b1c117ed8c103fd05cbb-53560c22a3c57b218bb31d8297af7e7c",
    "data": {
        "phone": "189xxxxx",
        "callmark": "f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667"
    }
}

发送暂停话机指令
{
    "msg": "ok",
    "action": "dnd",
    "code": "6706194107ea7fb6b85a8d88a11dc8b8d787d54afaa0ea592562ba3cc4dac1b7-a68801dbb7786acf9230c8b48e300dea",
    "data": []
}

发送启动话机指令
{
    "msg": "ok",
    "action": "idle",
    "code": "8cf520039a8fc0820b13dc1fd85bf6d80bb70b0541f10456d9414584d4fb28dd-34074b7c1f1b2f3e18afbeea0545313f",
    "data": []
}

错误时返回:


{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "电话号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "请先注册设备号！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型 “call” 发起呼叫，“dnd” 禁用话机 “idle” 启用话机
code	string	签名认证
data	string	json对象
--phone	string	呼叫号码
--callmark	string	业务标签，当系统"发起呼叫"指令时，

来电通知接口

该接口提供给话机方调用，通知话机来电的情况

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/pop.php

请求方式:

POST

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
phone	是	string	来电号码/去电号码
callmark	是	string	业务标签；呼出时请传回呼叫指令中的 “callmark” ；128位字符串
call_type	是	string	“callout” 呼出；“callin” 呼入

请求示例:

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "imei": "2013122000001",
    "code": "89eba0f5925aab2ad3f25c306b09517b27b2ab725f20403d562eee56bfb2e748-0df9b0b3a13dbbaf3553f711abc43f80",
    "phone": "135xxxx",
    "callmark": "f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667",
    "call_type": "callin"
}

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/pop.php' -H 'Content-Type: application/josn;charset=utf-8' -d '{"imei":"2013122000001","code":"022281ecacf4a6fef6b1992b0f406f8c1d653348ea50a92e6b381f2eac7a53e6-c9866b22bc851025b3cc37c0f15fef25","phone":"135xxxx","callmark":"f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667","call_type":"callin"}'

返回示例:

正确时返回:

{
    "msg": "ok",
    "action": "",
    "code": "",
}

错误时返回:

{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "电话号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}

{
    "msg": "业务标签不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "呼叫类型不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "请先注册设备号！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型
code	string	签名认证

挂机通知接口

话机挂机通知接口

该接口提供给话机方调用，通知话机挂机的情况

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/hangup.php

请求方式:

POST

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
phone	是	string	来电号码/去电号码
callmark	是	string	业务标签；呼出时请传回呼叫指令中的 “callmark” ；128位字符串
call_type	是	string	“callout” 呼出；“callin” 呼入

请求示例:

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"imei": "2013122000001",
	"code": "89eba0f5925aab2ad3f25c306b09517b27b2ab725f20403d562eee56bfb2e748-0df9b0b3a13dbbaf3553f711abc43f80",
	"phone": "135xxxx",
	"callmark": "f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667",
	"call_type": "callin"
}

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/hangup.php' -H 'Content-Type: application/josn;charset=utf-8' -d '{"imei":"2013122000001","code":"022281ecacf4a6fef6b1992b0f406f8c1d653348ea50a92e6b381f2eac7a53e6-c9866b22bc851025b3cc37c0f15fef25","phone":"135xxxx","callmark":"f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667","call_type":"callin"}'

返回示例:

正确时返回:

{
    "msg": "ok",
    "action": "",
    "code": "",
}

错误时返回:

{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "电话号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}

{
    "msg": "业务标签不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "呼叫类型不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "请先注册设备号！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型
code	string	签名认证

接听通知接口

话机接听通知接口

该接口提供给话机方调用，通知话机接听的情况

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/answer.php

请求方式:

POST

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
phone	是	string	来电号码/去电号码
callmark	是	string	业务标签；呼出时请传回呼叫指令中的 “callmark” ；128位字符串
call_type	是	string	“callout” 呼出；“callin” 呼入

请求示例:

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"imei": "2013122000001",
	"code": "89eba0f5925aab2ad3f25c306b09517b27b2ab725f20403d562eee56bfb2e748-0df9b0b3a13dbbaf3553f711abc43f80",
	"phone": "135xxxx",
	"callmark": "f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667",
	"call_type": "callin"
}

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/hangup.php' -H 'Content-Type: application/josn;charset=utf-8' -d '{"imei":"2013122000001","code":"022281ecacf4a6fef6b1992b0f406f8c1d653348ea50a92e6b381f2eac7a53e6-c9866b22bc851025b3cc37c0f15fef25","phone":"135xxxx","callmark":"f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667","call_type":"callin"}'

返回示例:

正确时返回:

{
    "msg": "ok",
    "action": "",
    "code": "",
}

错误时返回:

{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "电话号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}

{
    "msg": "业务标签不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "呼叫类型不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "请先注册设备号！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型
code	string	签名认证

话单接收接口

该接口提供给话机方调用，推送话单到系统

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/cdr.php

请求方式:

POST

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
caller	是	string	主叫号码
callee	是	string	被叫号码
callmark	是	string	业务标签；呼出时请传回呼叫指令中的 “callmark” ；128位字符串
call_type	是	string	“callout” 呼出；“callin” 呼入
call_time	是	string	呼叫时间：如"2023-12-21 14:12:12"
answer_time	是	string	接听时间：如"2023-12-21 14:12:22"
hangup_time	是	string	挂机时间：如"2023-12-21 14:42:22"

请求示例:

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"imei": "2013122000001",
	"code": "4c989d33f2fe5e9f5e949943f76a296439d611ba3baa25bf118a2f75a6966924-880096ea2cbbe5f5d4c75d22a2ad41ed",
	"caller": "13590189146",
	"callee": "18928464203",
	"callmark": "f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667",
	"call_type": "callin",
	"call_time": "2023-12-21 14:12:12",
	"answer_time": "2023-12-21 14:12:22",
	"hangup_time": "2023-12-21 14:42:22"
}

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/cdr.php' -H 'Content-Type: application/josn;charset=utf-8' -d '{"imei":"2013122000001","code":"022281ecacf4a6fef6b1992b0f406f8c1d653348ea50a92e6b381f2eac7a53e6-c9866b22bc851025b3cc37c0f15fef25","caller":"135xxxx","callee":"189xxxx","callmark":"f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667","call_type":"callin","call_time":"2023-12-21 14:12:12","answer_time":"2023-12-21 14:12:22","hangup_time":"2023-12-21 14:42:22"}'

返回示例:

正确时返回:

{
    "msg": "ok",
    "action": "",
    "code": "",
}

{
    "msg": "no",
    "action": "",
    "code": "",
}

错误时返回:


{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "主叫号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "被叫号码不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}

{
    "msg": "业务标签不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "呼叫类型不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "呼叫时间不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "接听时间不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "挂机时间不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "请先注册设备号！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型
code	string	签名认证

录音上传接口

该接口提供给话机方调用，推送录音文件到系统

请求URL:

http://dapi.wei-fu.cn:6983/phoneAPI/record.php

请求方式:

POST 表单提交

参数:

参数	是否必填	类型	说明
imei	是	string	话机ID
code	是	string	签名认证
callmark	是	string	业务标签；呼出时请传回呼叫指令中的 “callmark” ；128位字符串
call_time	是	string	呼叫时间：如"2023-12-21 14:12:12"
file	是	string	录音文件

请求示例:

CURL请求示例:

curl -X POST 'http://dapi.wei-fu.cn:6983/phoneAPI/voice.php' -H "Content-Type:multipart/form-data" -F 'imei=2013122000001' -F 'code=a8a32634bed23ced5eaeef9361f8833a70d8587ee9fc98034ab3a6d64bff549b-cf6afd3a184f75a7f3263c2224bb2999' -F 'callmark=f61f6152bc6526b2bb4542c42540c79da4bf314dbc2bc5e2f2cbdb0bd68e6667' -F 'call_time=2023-12-22 14:12:12' -F 'file=@"/root/ghcs.mp3"'

返回示例:

正确时返回:


{
    "msg": "ok",
    "action": "",
    "code": "",
}

{
    "msg": "no",
    "action": "",
    "code": "",
}

错误时返回:

{
    "msg": "参数不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "设备imei不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "签名code错误！",
    "action": "",
    "code": ""
}
{
    "msg": "录音文件不能为空！",
    "action": "",
    "code": ""
}
{
    "msg": "业务标签不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "呼叫时间不能为空！",
    "action": "",
    "code": ""
}

{
    "msg": "请先注册设备号！",
    "action": "",
    "code": ""
}

返回参数说明:

参数名	类型	说明
msg	string	返回信息，"ok","no","";ok为正常，其他为异常
action	string	指令类型
code	string	签名认证