Skip to content

Message APIs

1. Prerequisites

Base URL: https://api.rokid.com

2. Overview

The message module covers send, receive and storage so cloud services can talk with phones and glasses.

2.1 Send message

Endpoint https://api.rokid.com/ar/core/openapi/push/messages

Method POST

Request application/json

Response */*

Description Push a message to the target device.

Parameters

NameDescriptionRequiredType
deviceIdDevice SNtruestring
businessTypeBusiness type; use inspection for Lingmoutruestring
sourceOrigin label, e.g. “Support”truestring
titleMessage titletruestring
introductionShort introtruestring
bodyMessage bodytruestring

Example

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":"YOUR_DEVICE_SN",
    "businessType":"inspection",
    "source":"Support",
    "title":"Sample title",
    "introduction":"Intro",
    "body":"Message body"
}'

Sample response

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