Skip to content

消息管理

1. 准备

基础域名:https://api.rokid.com

2. 功能介绍

消息管理模块提供了消息的发送、接收、存储等功能,帮助开发者实现与眼镜和手机端的消息交互。

2.1 发送消息

接口地址:https://api.rokid.com/ar/core/openapi/push/messages

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述: 发送消息到指定的设备

请求参数:

参数名称参数说明是否必须数据类型
deviceId设备SN号truestring
businessType业务类型,固定传inspectiontruestring
source业务模块,比如:客服truestring
title消息标题truestring
introduction简介truestring
body消息正文内容truestring

请求示例:

json
curl -X POST https://api.rokid.com/ar/core/openapi/push/messages \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "deviceId":"设备SN号",
    "businessType":"inspection", //灵眸业务
    "source":"业务模块",  //来源,可以为业务模块,可以是消息原因,比如:客服
    "title":"消息标题",
    "introduction":"简介",
    "body":"{\"url\":\"XXX\"}" //消息内容,JSON字符串,url为了跳转使用,key必须存在
}'

响应示例:

json
{
    "code": 0,
    "message": "OK",
    "data": "success",
    "success": true
}