1. 功能说明

用于用户接受通知消息、和设备的交互、透传命令等

2. 协议设计原则

• 完全支持RFC6455 ，WebSocket协议标准的最新版，并兼容socket.io库的默认事件
• 采用json文本协议，保证协议可读性高和扩展性
• 不添加额外的HTTP头部信息，只使用标准HTTP头部信息
• 字段类型为text，编码格式为UTF-8，数据长度最大65535字节
• text内容为json数组，下标0为消息类型，下标1为具体的数据
• 本服务为MNS

3. 通讯地址

wss://mns.wonlycloud.com:10500

4. 事件定义

定义	描述
MSG_USER_AUTH_REQ	请求用户验证
MSG_USER_AUTH_RSP	应答用户验证
MSG_USER_BIND_DEVICE_REQ	请求用户绑定设备
MSG_USER_BIND_DEVICE_RSP	应答用户绑定设备
MSG_DEVICE_OPERATED_REQ	请求设备操作通知
MSG_DEVICE_UNLOCK_REQ	请求设备开锁通知
MSG_DEVICE_ALARM_REQ	请求设备报警通知
MSG_USER_INITIATE_INTERCOM_REQ	请求用户发起对讲
MSG_USER_INITIATE_INTERCOM_RSP	应答用户发起对讲
MSG_DEVICE_START_PUSHFLOW_REQ	请求设备开始推流通知
MSG_USER_START_PUSHFLOW_REQ	请求用户开始推流
MSG_USER_START_PUSHFLOW_RSP	应答用户开始推流
MSG_DEVICE_STOP_PUSHFLOW_REQ	请求设备停止推流通知
MSG_USER_TRANSPORT_REQ	请求用户透传
MSG_USER_TRANSPORT_RSP	应答用户透传
MSG_DEVICE_TRANSPORT_REQ	请求设备透传通知
MSG_USER_DEVICE_STATUS_QUERY_REQ	请求用户查询设备状态
MSG_USER_DEVICE_STATUS_QUERY_RSP	应答用户查询设备状态
MSG_DEVICE_INFO_UPDATE_REQ	请求设备信息更新通知
MSG_KICKED_USER_REQ	请求踢出用户通知
MSG_USER_HEARTBEAT_REQ	请求用户心跳
MSG_USER_HEARTBEAT_RSP	应答用户心跳
MSG_USER_TTS_REQ	请求用户语音和成
MSG_USER_TTS_RSP	应答用户语音和成
MSG_TTS_COMPLETE_REQ	语音合成完成通知

5. 协议详解

每条协议都包含请求应答示例、请求参数说明、应答参数说明三个部分

5.1 用户验证

• 请求应答示例

MSG_USER_AUTH_REQ

[
    "MSG_USER_AUTH_REQ",
    {
        "token": "xxxxxxxxxxxxxxx",
        "api_version": "1.0",
        "username": "18888888888"
    }
]

MSG_USER_AUTH_RSP

[
    "MSG_USER_AUTH_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:username	必填	用户名	用户名，一般为手机号

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表

5.2 用户绑定设备

• 请求应答示例

MSG_USER_BIND_DEVICE_REQ

[
    "MSG_USER_BIND_DEVICE_REQ",
    {
        "token": "xxxxxxxxxxxxx",
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "random_key": "xxxxxxxxx",
        "network_ssid": "xxxxxxxxx",
        "mac_addr": "xxxxxxxxx"
    }
]

MSG_USER_BIND_DEVICE_RSP

[
    "MSG_USER_BIND_DEVICE_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:random_key	必填	设备随机码	用于加密及其他用途
[1]:network_ssid	必填	网络的SSID	网络的SSID
[1]:mac_addr	必填	设备物理地址	设备的物理地址

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表

5.3 设备操作通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_DEVICE_OPERATED_REQ

[
    "MSG_DEVICE_OPERATED_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "timestamp": "1499681215",
            "type": "WonlyVideoLock",
            "note": "我的视频锁",
            "device_user_id": "001,002",
            "device_user_note": "阿三,阿九",
            "be_operated": {
                "mode": "del",
                "object": "001",
                "object_level": "adm",
                "object_note": "阿四",
                "unlock_mode": "pwd,fp,card"
            }
        }
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:timestamp	必填	时间戳	设备操作的UNIX时间戳
[1]:data:type	必填	设备类型	设备的类型，WonlyVideoLock (视频锁) WonlySmartEye (猫眼) WonlySmartAirer (晾霸)
[1]:data:note	必填	设备别名	设备的别名
[1]:data:device_user_id	必填	设备用户id	设备用户的id，双人和多重验证为多个授权人的id，格式001,002,003
[1]:data:device_user_note	必填	设备用户别名	设备用户的别名，格式阿三,阿九
[1]:data:be_operated:object	必填	被操作对象	被操作的对象，可以是具体用户的id，也可以是用户组和所有用户adm_grp usr_grp tmp_grp all
[1]:data:be_operated:object_level	必填	被操作对象的等级	被操作用户的等级，设备用户的等级，adm usr tmp
[1]:data:be_operated:object_note	必填	被操作对象的别买	被操作对象的别名
[1]:data:be_operated:mode	必填	操作方式	操作的方式，create add del update
[1]:data:be_operated:unlock_mode	必填	开锁方式	开锁的方式，格式为pwd,fp,card，可以多选，all (所有) pwd (密码) fp (指纹) card (刷卡) face (人脸) rf (感应) eye (虹膜) vena (指静脉) remote (远程) timeslot (时间段)

5.4 设备开锁通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_DEVICE_UNLOCK_REQ

[
    "MSG_DEVICE_UNLOCK_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "timestamp": "1499681215",
            "type": "WonlyVideoLock",
            "note": "我的视频锁",
            "device_user_id": "001",
            "device_user_note": "阿三",
            "unlock_mode": "pwd",
            "auth_mode": "dbl",
            "stress_status": "false",
            "op_type": "enter_menu"
        }
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:timestamp	必填	时间戳	开锁记录的UNIX时间戳
[1]:data:type	必填	设备类型	设备的类型，WonlyVideoLock (视频锁) WonlySmartEye (猫眼) WonlySmartAirer (晾霸)
[1]:data:note	必填	设备别名	设备的别名
[1]:data:device_user_id	必填	设备用户id	设备用户的id
[1]:data:device_user_note	必填	设备用户别名	设备用户的别名，格式阿九
[1]:data:power	必填	设备电量	设备的电量，范围0 - 100
[1]:data:unlock_mode	必填	开锁方式	开锁的方式，pwd (密码) fp (指纹) card (刷卡) face (人脸) rf (感应) eye (虹膜) vena (指静脉) remote (远程)
[1]:data:auth_mode	必填	验证方式	验证的方式，sgl (单人) dbl (双人) mutil (多人)
[1]:data:stress_status	必填	胁迫状态	是否被胁迫，true false
[1]:data:op_type	必填	操作类型	enter_menu (进入菜单) off_lock (取消常开) on_lock (启用常开) default (恢复出厂设置) on_infra (启用红外报警) off_infra (取消红外报警)

5.5 设备报警通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_DEVICE_ALARM_REQ

[
    "MSG_DEVICE_ALARM_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "timestamp": "1499681215",
            "type": "WonlyVideoLock",
            "note": "我的视频锁",
            "device_user_id": "001",
            "device_user_note": "阿三",
            "alarm_type": "noatmpt",
            "alarm_message": "https://download.wonlycloud.com/slideshow/banner2.png",
            "alarm_message_type": "pic"
        }
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:timestamp	必填	时间戳	报警数据的UNIX时间戳
[1]:data:type	必填	设备类型	设备的类型，WonlyVideoLock (视频锁) WonlySmartEye (猫眼) WonlySmartAirer (晾霸)
[1]:data:note	必填	设备别名	设备的别名
[1]:data:device_user_id	可选	设备用户id	设备用户的id
[1]:data:device_user_note	可选	设备用户别名	设备用户的别名，格式阿九
[1]:data:alarm_type	必填	报警类型	报警的类型，noatmpt (非法操作) fakelock (假锁) nolock (门未关) batt (低电量) infra (红外感应) call (门铃呼叫) relock (解除门未关) rm_fake (解除假锁)
[1]:data:alarm_message	可选	报警消息	报警视频或报警图片的地址
[1]:data:alarm_message_type	必填	报警数据类型	报警的数据类型，txt pic av

5.6 用户发起对讲

• 请求应答示例

MSG_USER_INITIATE_INTERCOM_REQ

[
    "MSG_USER_INITIATE_INTERCOM_REQ",
    {
        "token": "xxxxxxxxxxxxxxx",
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "action": "call"
        }
    }
]

MSG_USER_INITIATE_INTERCOM_RSP

[
    "MSG_USER_INITIATE_INTERCOM_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:action	必填	对讲动作	具体的动作，call hangup-所有在线手机挂断后，服务器才会发 waitconfig-延长设备在线等待时间

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表

5.7 设备开始推流通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_DEVICE_START_PUSHFLOW_REQ

[
    "MSG_DEVICE_START_PUSHFLOW_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "device_rtsp_url": "rtsp://123.123.123.123:10700/[uuid][timestamp].sdp"
        }
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:device_rtsp_url	必填	设备直播地址	设备RTSP直播地址

5.8 用户开始推流

• 请求应答示例

MSG_USER_START_PUSHFLOW_REQ

[
    "MSG_USER_START_PUSHFLOW_REQ",
    {
        "token": "xxxxxxxxxxxxxxx",
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "app_rtsp_url": "rtsp://[通过`CMS`获取的地址]:[通过`CMS`获取的端口]/[username][timestamp].sdp"
        }
    }
]

MSG_USER_START_PUSHFLOW_RSP

[
    "MSG_USER_START_PUSHFLOW_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:app_rtsp_url	必填	移动端直播地址	移动端RTSP直播地址

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表

5.9 设备停止推流通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_DEVICE_STOP_PUSHFLOW_REQ

[
    "MSG_DEVICE_STOP_PUSHFLOW_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码

5.10 用户透传

• 请求应答示例

MSG_USER_TRANSPORT_REQ

[
    "MSG_USER_TRANSPORT_REQ",
    {
        "api_version": "1.0",
        "token": "xxxxxxxxxxxxxxx",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "cmd": "REMOTE_UNLOCK",
        "data": "具体透传的内容"
    }
]

MSG_USER_TRANSPORT_RSP

[
    "MSG_USER_TRANSPORT_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING",
        "cmd": "REMOTE_UNLOCK"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:cmd	必填	透传命令	需参考DAS 6.透传命令
[1]:data	必填	透传命令数据	需参考DAS 6.具体透传的内容，原文为json字符串，此处为base64编码后的字符串

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表
[1]:cmd	透传命令	需参考DAS 6.透传命令

5.11 设备透传通知

• 请求应答示例

MSG_DEVICE_TRANSPORT_REQ

[
    "MSG_DEVICE_TRANSPORT_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "username": "18888888888",
        "data": "具体透传的内容"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:username	必填	用户名	用户名，一般为手机号
[1]:data	必填	透传命令数据	需参考DAS 6.具体透传的内容

5.12 用户查询设备状态

• 请求应答示例

MSG_USER_DEVICE_STATUS_QUERY_REQ

[
    "MSG_USER_DEVICE_STATUS_QUERY_REQ",
    {
        "api_version": "1.0",
        "token": "xxxxxxxxxxxxxxx",
        "device_list": [
            {
                "vendor_name": "general",
                "uuid": "xxxxxxxxxxxxx"
            },
            {
                "vendor_name": "general",
                "uuid": "xxxxxxxxxxxxx"
            }
        ]

    }
]

MSG_USER_DEVICE_STATUS_QUERY_RSP

[
    "MSG_USER_DEVICE_STATUS_QUERY_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING",
        "status_list": [
            {
                "vendor_name": "general",
                "uuid": "xxxxxxxxxxxxx",
                "status": "online",
                "power": "50"
            },
            {
                "vendor_name": "general",
                "uuid": "xxxxxxxxxxxxx",
                "status": "online",
                "power": "50"
            }
        ]
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:device_list:vendor_name	必填	设备供应商名	见公共参数
[1]:device_list:uuid	必填	设备的唯一码	设备的唯一标识码

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表
[1]:status_list:vendor_name	设备供应商名	见公共参数
[1]:status_list:uuid	设备的唯一码	设备的唯一标识码
[1]:status_list:status	设备状态	设备具体的状态，bind online offline
[1]:status_list:power	设备电量	设备的电量，0 - 100

5.13 设备信息更新通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_DEVICE_INFO_UPDATE_REQ

[
    "MSG_DEVICE_INFO_UPDATE_REQ",
    {
        "api_version": "1.0",
        "vendor_name": "general",
        "uuid": "xxxxxxxxxxxxx",
        "data": {
            "status": "online",
            "power": "50",
            "version": "xxxxxxxx",
            "network_ssid": "xxxxxxxxx",
            "infrared_alarm_interval_time": "30",
            "infrared_alarm_type": "txt",
            "volume_level": "2",
            "infrared_sensitivity": "50",
            "auth_mode": "0",
            "activation_code": "12311",
            "dev_model": "Z501",
            "dev_id": "xxxxxxx",
            "on_off": "0,1,1,0,1,0,1,0"
        }
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:vendor_name	必填	设备供应商名	见公共参数
[1]:uuid	必填	设备的唯一码	设备的唯一标识码
[1]:data:status	可选	设备状态	设备具体的状态，bind online offline
[1]:data:power	可选	设备电量	设备的电量，0 - 100
[1]:data:version	可选	设备版本	设备的版本
[1]:data:network_ssid	可选	网络的SSID	网络的SSID
[1]:data:infrared_alarm_interval_time	可选	红外报警检测时间	红外报警检测的间隔时间，30 - 120
[1]:data:infrared_alarm_data_type	可选	报警数据类型	报警的数据类型，txt pic av
[1]:data:volume_level	可选	音量等级	1 - 3
[1]:data:infrared_sensitivity	可选	红外灵敏度	1 - 100
[1]:data:auth_mode	可选	验证模式	0 (单人验证) 1 (双人验证)
[1]:data:activation_code	可选	激活码	激活码
[1]:data:dev_model	可选	设备型号	设备型号
[1]:data:dev_id	可选	设备串码	设备串码
[1]:data:on_off	可选	功能开关	0,1,1,0,1,0,1,0 对应 关闭红外报警，开启门锁常开，开启门未关报警，关闭假锁报警，开启密码功能，关闭红外检测，开启网络常在线，关闭远程控制

5.14 踢出用户通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_KICKED_USER_REQ

[
    "MSG_KICKED_USER_REQ",
    {
        "api_version": "1.0",
        "timestamp": "1499681215"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:timestamp	必填	时间戳	被踢时的UNIX时间戳

5.15 用户心跳

建议1分钟发一次

• 请求应答示例

MSG_USER_HEARTBEAT_REQ

[
    "MSG_USER_HEARTBEAT_REQ",
    {
        "token": "xxxxxxxxxxxxxxx",
        "api_version": "1.0"
    }
]

MSG_USER_HEARTBEAT_RSP

[
    "MSG_USER_HEARTBEAT_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表

5.16 用户语音合成

• 请求应答示例

MSG_USER_TTS_REQ

[
    "MSG_USER_TTS_REQ",
    {
        "token": "xxxxxxxxxxxxx",
        "api_version": "1.0",
        "tts_text": "王力智能语音合成测试程序"
    }
]

MSG_USER_TTS_RSP

[
    "MSG_USER_TTS_RSP",
    {
        "api_version": "1.0",
        "return_string": "RETURN_SUCCESS_OK_STRING",
        "file_url": "http://download-tts.wonlycloud.com/xiaoyan/wanglizhinengyuyinhechengceshichengxu.pcm"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:token	必填	授权令牌	通过AMS申请获得
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:tts_text	必填	文本信息	需要转化的文本文字

• 应答参数说明

参数	说明	备注
[0]	自定义事件	自定义的通讯事件
[1]:api_version	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:return_string	返回的状态信息	见API状态码对照表
[1]:file_url	语音文件地址	语音文件的下载地址

5.17 语音合成完成通知

注意：用户不需要发送此命令，但需要处理服务器转发过来的请求

• 请求应答示例

MSG_TTS_COMPLETE_REQ

[
    "MSG_TTS_COMPLETE_REQ",
    {
        "api_version": "1.0",
        "file_url": "http://download-tts.wonlycloud.com/xiaoyan/wanglizhinengyuyinhechengceshichengxu.pcm"
    }
]

• 请求参数说明

参数	选项	说明	备注
[0]	必填	自定义事件	自定义的通讯事件
[1]:api_version	必填	王力云平台的API版本，所有服务统一版本号	见公共参数
[1]:file_url	必填	语音文件地址	语音文件的下载地址

---

6. 极光推送扩展字段

极光推送扩展字段

extras

[
    "extras":
    {
        "vendor": "general",
        "uuid": "866971031059996",
        "devtype": "WonlyNBVideoLock",
        "device_type": "WonlyNBVideoLock",
        "type": "_WonlyAlarm",

        "battery": "91",

        "picUrl":"https://i.ys7.com/streamer/alarm/url/get?fileId=20190321102724-C64681406-1-10000-2-1&deviceSerialNo=C64681406&cn=1&isEncrypted=1&isCloudStored=0&ct=1&lc=7&bn=1_hikalarm&isDevVideo=0",
        "random":"EKLUAK",
        "time":"1553135243",
        "channelNo":"1",

        "periodNumber":"1",
        "buildingNumber":"1",
        "unitNumber":"1",
        "floorNumber":"1",
        "roomNumber":"2",
        "unitType":"outdoor",
        "devIndex":"0"
    }
]

• 扩展字段

参数	说明	备注
vendor	生产商	生产商，见1.1 公共参数：vendor_name
uuid	设备编号	设备编号
devtype，device_type	设备类型	见1.1 公共参数：device_type
type	消息类型	开门消息_WonlyUnlock, 报警消息_WonlyAlarm, 门铃呼叫消息_WonlyCall
battery	电池电量	电池电量百分比，开门消息会带上电池电量
picUrl	图片地址	萤石猫眼抓拍的图片地址
random	萤石设备校验码	萤石设备校验码
time	报警时间	萤石猫眼报警时间
channelNo	萤石设备视频通道号	萤石设备视频通道号
periodNumber	小区的分区号	门口机所安装的小区分区号
buildingNumber	楼栋号	几栋
unitNumber	楼单元号	几单元
floorNumber	楼层号	几层
roomNumber	房间号	房间号
unitType	门口机设备类型	outdoor
devIndex	门口机索引号	门口机索引号