HTTPS API

HTTPS API

Central control HTTPS API authentication instructions

Due to the addition of authentication mechanism, it is necessary to first execute the authentication process, and
upon successful authentication, obtain the token. Subsequent API calls should include this token for verification.
Request authentication as a POST with the password parameter (value is the admin password of the requested
device):

POST /centralcontrol/authentication

{
"password": "0000"
}

If the request and validation are successful, a string of tokens will be obtained:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"token":"6118C27AAC154D79BFC955A4F63E3C42"
}
}

1. Token usage method

The obtained token field is filled in the "Authorization" field in the https request header as the authentication
check field value:

User-Agent: PostmanRuntime-ApipostRuntime/1.1.0
Cache-Control: no-cache
content-type: application/json
Accept: */*
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Authorization: Bearer 6118C27AAC154D79BFC955A4F63E3C42
Content-Length: 27

All subsequent requests need to bring the token in order to verify the success and perform the corresponding
functions. If accessing an app-related interface, the app name parameter needs to be included.

2. Business authentication failed

1
 HTTPS API

Supported MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

Models UVC40

When a business request is made and authentication fails, the following response example will be returned:
Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":500
}

At this point, the client can initiate a reauthentication request.

3. Handling exceeding limits

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

If the concurrent number of business requests exceeds ten, the server's concurrency limit mechanism will be
triggered, and the following response instance will be returned.
Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":500
}

Admission service

Authentication and authorization

1. Authentication

Basic Information
Method: POST
Path: /centralcontrol/authentication

Supported MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

Models UVC40

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

password string NULL Yes authentication code

Return Value:

2
 HTTPS API

Name Typology Range of Values Note

token string NULL Successful authentication of the token

Note
Example of a request

POST /centralcontrol/authentication

{
"password": "0000"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"token":"6118C27AAC154D79BFC955A4F63E3C42"
}
}

Basic information

Basic information query/retrieval (This document includes system information, network information, device list.
For other system status, mute status, volume level, camera information, screen brightness, conference platform
list, please refer to the Control service.

1. Access to system information

Basic Information
Method: GET
Path: /centralcontrol/system/version

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, UVC40

Request Parameters:
Body:
NULL
Return Value:

Name Typology Note

model string Device type

firmware string Firmware version

hardware string
Hardware version

3
 HTTPS API

serialnumber string Device sn number

macaddress string Device mac address

cc-version string Central control version

Note
Example of a request

GET /centralcontrol/system/version

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"model":"MeetingEye 500",
"firmware":"[Link]",
"hardware":"[Link].3.0.36",
"macaddress":"00:15:65:00:00:00",
"serialnumber":"506607D117000009",
"cc-version":"[Link]"
}
}

2. Access to network information

Basic Information
Method: GET
Path: /centralcontrol/network/info

Supported Models UVC40, MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:
NULL
Return Value:

Name Typology Range of Values Note

network-list network_info[] NULL network information list

network_info

Name Typology Range of Values Note

4
 HTTPS API

Acquire network method:

type int [0,1] 0: Dynamic acquisition
1: Static setting

Port-type0:
0: Wired port 1
port-type int [0,1,2]
1: Wired port 2
2: Wireless port

IP type:
0: IPv4
mode int [0,1,2]
1: IPv6
2: IPv4 and IPv6

ip string NULL IP address

mask string NULL Subnet mask

gateway string NULL Gateway

primary-dns string NULL Primary DNS server name

second-dns string NULL Secondary DNS server name

Note
Example of a request

GET /centralcontrol/network/info

{
}

Response Example

5
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data": {
"network-list": [
{
"type": 0,
"port-type": 2,
"mode": 0,
"ip": "",
"mask": "",
"gateway": "",
"primary-dns": "",
"second-dns": ""
},
{
"type": 0,
"port-type": 0,
"mode": 0,
"ip": "[Link]",
"mask": "[Link]",
"gateway": "[Link]",
"primary-dns": "[Link]",
"second-dns": "[Link]"
}
]
}
}

3. Get device list

Basic Information
Method: GET
Path: /centralcontrol/system/devices

Supported Models Yealink RoomConnect, MeetingBoard 65 /86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:
NULL
Return Value:

Name Typology Range of Values Note

device-list device_info [] NULL List of device information

device_info

Name Typology Note

model string Device type

firmware string Firmware version

6
 HTTPS API

hardware string Hardware version

serialnumber string Device sn number

macaddress string Device mac address

Note
Example of a request

GET /centralcontrol/system/devices

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"device-list": [
{
"model":"UVC86",
"firmware":"[Link]",
"hardware":"[Link].3.0.36",
"macaddress":"00:15:65:00:00:00",
"serialnumber":"506607D117000009",
},
{
"model":"UVC84",
"firmware":"[Link]",
"hardware":"[Link].43.0.58",
"macaddress":"00:24:13:00:00:00",
"serialnumber":"803032E070000031",
}
]
}
}

4. Retrieve app information list

Basic Information
Method: GET
Path: /centralcontrol/app/info

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:
NULL
Return Value:

7
 HTTPS API

Name Typology Range of Values Note

app-list app_list [] NULL List of device information

app_list

Name Typology Note

id string App package name

name string App name

version string App version number

Note
Example of a request

GET /centralcontrol/app/info

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"app-list": [
{
"id":"[Link]",
"name":"BYOD",
"version":"1.0"
},
{
"id":"[Link]",
"name":"投屏",
"version":"21.1.2-TS.2"
}
]
}
}

5. Get call status

Basic Information
Method: GET
Path: /centralcontrol/system/call-state

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:

8
 HTTPS API

Body:
NULL
Return Value:

Name Typology Range of Values Parameter Description

incoming: Incoming call

incall: In a call
[incoming, incall,
call-state string idle: Idle
idle]
The states of "incoming" and "incall" can be considered as
being in a call.

The package name of the app in a call, or "" if it is not in the

package string NULL
call.

Note
Example of a request

GET /centralcontrol/system/call-state

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"call-state": "incoming",
"package": "[Link]"
}
}

Control service

Remote control of audio and video devices, displays, and entire machines, including obtaining status information
required for control.

1. System state control

1). Get system status

Basic Information
Method: GET
Path: /centralcontrol/system/status

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

9
 HTTPS API

NULL
Return Value:

Name Typology Range of Values Parameter Description

System status:
status string [sleeping,wake-up] sleeping: Sleep
wake-up: Wake up

Note
Example of a request

GET /centralcontrol/system/status

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"status":"wake-up"
}
}

2). Set system status

Basic Information
Method: POST
Path: /centralcontrol/system/status

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

UVC40

Supported
 NOTE
Models
1. Yealink RoomConnect/UVC only support restart and factory reset.
2. Only Yealink RoomConnect supports passing the sn parameter.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

10
 HTTPS API

System status:
sleeping: Sleep
status string [sleeping,wake-up,reboot,reset] Yes wake-up: Wake up
reboot: Reboot
reset: Factory restore

sn string NULL No Device unique identifier SN

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/system/status

{
"status":"sleeping",
"sn":"506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

2. Audio control

1). Obtain mute status

Basic Information
Method: GET
Path: /centralcontrol/audio/mute

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, UVC40

Request Parameters:
Body:
NULL
Return Value:

Name Typology Range of Values Parameter Description

Mute status:
status string [on,off] on: On
off: Off

Note
Example of a request

11
 HTTPS API

GET /centralcontrol/audio/mute

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"status":"on"
}
}

2). Setting the Mute State（ MVC）

Basic Information
Method: POST
Path: /centralcontrol/audio/mute

UVC40, Yealink RoomConnect, AVHub

Supported Models  NOTE

Only Yealink RoomConnect supports passing the sn parameter.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Mute status:
status string [on,off] Yes on: On
off: Off

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/mute

{
"status": "off",
"sn":"506607D117000009"
}

12
 HTTPS API

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

3). Setting the Mute State（ VCS）

Basic Information
Method: POST
Path: /centralcontrol/button

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40.

 NOTE
Supported
The operation of this interface is inversely related to the actual microphone status:
Models
when the current status is unmuted, it will be muted after the post; when the current
status is muted, it will be unmuted after the post.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

key string [mute] Yes Key name

** Return Value:
NULL
Note
Example of a request

POST /centralcontrol/button

{
"key": "mute"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

4). Obtain volume

Basic Information
Method: GET

13
 HTTPS API

Path: /centralcontrol/audio/volume

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, UVC40, AVHub

 NOTE
1. When UVC and AVHub devices request this interface, there is no need to include
Supported
parameters.
Models
2. MeetingBoard 65 /86, MeetingEye 500/900, MeetingBar A10/A40 can optionally include
a volume type parameter, with the default being idle.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Volume type:
type string [idle,talk] No idle: Ringer volume
talk: Call volume

Return Value:

Name Typology Range of Values Parameter Description

value int [0~15] Loudness value

Note
Example of a request

GET /centralcontrol/audio/volume

{
"type": "talk"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"value":5
}
}

5). Adjust volume

Basic Information
Method: POST
Path: /centralcontrol/audio/volume

14
 HTTPS API

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Supported  NOTE
Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40 optionally fill volume
type parameters, default to idle (idle and talk volume will be synchronized).

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

value int [0-15] Yes Loudness value

Volume type
type string [idle,talk] No idle: Ringer volume
talk: Call volume

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/volume

{
"type": "idle",
"value": 3
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

6). Set audio input source

Basic Information
Method: POST
Path: /centralcontrol/audio/input-source

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

15
 HTTPS API

Audio input source identification:

auto: Automatic
[auto,vcp,microphone,
vcp: CP96X
built-mic,
built-mic: Built-in mic
linein,usb-linein,
type string Yes linein: Line In
vcm34,vcm38,
usb-linein: USB to Line In
vcm36_w,bt-headset,
bt-headset: Bluetooth headset
vcm36,vcm40]
vcm34~vcm40: VCM series devices

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/input-source

{
"type": "auto"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

7). Set audio output source

Basic Information
Method: POST
Path: /centralcontrol/audio/output-source

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

16
 HTTPS API

Audio output source identifiers:

auto: Automatic
vcp: CP96X
[auto,vcp,
hdmi: HDMI
hdmi,lineout,
lineout: Line Out
usb-lineout,
usb-lineout: USB to Line Out
type string vcp-lineout, Yes
vcp-lineout: CP96X to Line Out
builtin-speaker,builtin-
builtin-speaker: Built-in speaker
speaker-lineout,
builtin-speaker-lineout: Built-in
mspeaker]
speaker + Line Out
mspeaker: Video conference
soundbar

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/output-source

{
"type": "vcm40"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

8). Set input audio noise reduction

Basic Information
Method: POST
Path: /centralcontrol/audio/input/noise-reduction

Yealink RoomConnect

 NOTE
Supported
1. Models compatible with AI-mode: AVHub, UVC84, UVC86.
Models
2. Models compatible with level: AVHub, UVC84, UVC86, VCM34, VCM35, VCM38,
CM20.

Request Parameters:
Body:

17
 HTTPS API

Name Typology
Range of Values Compulsory Parameter Description

AI intelligent noise reduction mode:

ai-mode string [on,off] No on: Enable
off: Disable

Inhibition Level:
0: Off
level int [0,1,2.3] No 1: Weak
2: Normal
3: Strong

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/input/noise-reduction

{
"sn":"506607D117000009",
"ai-mode": "on",
"level":2
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

9). Set input audio gain

Basic information:
Method: POST
Path: /centralcontrol/audio/input/gain

Yealink RoomConnect

Supported  NOTE
Models The parameters "rca-value" and "line-value" only take effect on AVhub when
adjusting the device.

Request parameters:
Body:

18
 HTTPS API

Name Typology Range of Values Compulsory Parameter Description

Gain control status:

status string [on,off] Yes on: Enable
off: Disable

gain-value int [-30~30] No Gain adjustment value

rca-value int [-12~40] No RCA input adjustment value

line-value int [-12~40] No Line input adjustment value

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/input/gain

{
"status":"on",
"sn":"506607D117000009",
"gain-value":20,
"rca-value":-6,
"line-value":12
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

10). Set up input audio echo cancellation

Basic Information
Method: POST
Path: /centralcontrol/audio/input/echo-cancellation

Supported Models Yealink RoomConnect

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Echo cancellation status:

status string [on,off] Yes on: Enable
off: Disable

19
 HTTPS API

Echo cancellation level:

0: Low
suppress-level int [0,1,2] No
1: Medium
2: High

Room reverberation level:

0: Low
reverb-level int [0,1,2] No
1: Medium
2: High

Manual delay:
manual-dalay string [on,off] No on: Turn on
off: Turn off

delay-value int [-100~500] No Audio AEC delay count (unit: ms)

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/input/echo-cancellation

{
"status":"on",
"sn":"506607D117000009",
"suppress-level":1,
"reverb-level":0,
"manual-dalay":"on",
"delay-value":200
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

11). Set input audio equalizer

Basic Information
Method: POST
Path: /centralcontrol/audio/input/equalizer

Supported Models Yealink RoomConnect

Request Parameters:
Body:

20
 HTTPS API

Name Typology Compulsor

Range of Values Parameter Description
y

Equalizer status:
status string [on,off] Yes on: Enable
off: Disable

Equalizer mode:
[custom,bass-
custom: Custom
boost, <br> trebl
mode string Yes bass-boost: Bass boost
e-boost,vocal-
treble-boost: Treble boost
boost]
vocal-boost: Vocal boost

The custom mode frequency band list

frequency- includes the following data: 20Hz, 63Hz,
int [-12~12] No
range-list 125Hz, 250Hz, 500Hz, 1000Hz, 2000Hz,
4000Hz, 8000Hz, 20000Hz.

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/input/equalizer

{
"sn":"506607D117000009",
"status": "on",
"mode":"custom",
"frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

12). Set output audio gain

Basic Information
Method: POST
Path: /centralcontrol/audio/output/gain

Supported Models Yealink RoomConnect

Request Parameters:
Body:

21
 HTTPS API

Name Typology Range of Values Compulsory Parameter Description

Gain control status:

status string [on,off] Yes on: Enable
off: Disable

gain-value int [-30~30] No Gain adjustment value

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/output/gain

{
"status":"on",
"sn":"506607D117000009",
"gain-value":20,
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

13). Set up output audio equalizer

Basic Information
Method: POST
Path: /centralcontrol/audio/output/equalizer

Supported Models Yealink RoomConnect

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Equalizer status:
status string [on,off] Yes on: Enable
off: Disable

22
 HTTPS API

Equalizer mode:
[custom,bass-
custom: Custom
boost, <br> trebl
mode string Yes bass-boost: Bass boost
e-boost,vocal-
treble-boost: Treble boost
boost]
vocal-boost: Vocal boost

The custom mode frequency band list

frequency- includes the following data: 20Hz, 63Hz,
int [-12~12] No
range-list 125Hz, 250Hz, 500Hz, 1000Hz, 2000Hz,
4000Hz, 8000Hz, 20000Hz.

sn string NULL No Device unique identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/audio/output/equalizer

{
"sn":"506607D117000009",
"status": "on",
"mode":"custom",
"frequency-range-list":[12,5,-12,3,6,10,-5,2,0,3,9]
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

3. Camera control

1). Camera movement

Basic Information
Method: POST
Path: /centralcontrol/camera/move

23
 HTTPS API

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

UVC40, UVC86, SmartVision 40, AVHub.

 NOTE
1. Yealink RoomConnect and AVHub require the sn parameter to be included in the
command.
2. The sn parameter for MeetingBar A10/A40 is optional.
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
Supported parameter can be optionally filled. However, if there are multiple cameras, the sn
Models parameter should be used to specify the correct camera for the intended operation.
4. UVC devices and SmartVision 40 do not require the sn parameter to be included.

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Camera movement direction:

up: Control camera direction to move up
[up,down
down: Control camera direction to move down
direction string ,left,right,st Yes
left: Control camera direction to move left
op]
right: Control camera direction to move right
stop: Control camera to stop

Camera Unique Identifier

 NOTE
If the command is requested with the sn
sn string NULL No parameter, it means that the control is for
the device with the specified sn, otherwise
the control is for the first device in the
camera list.

Return Value:
NULL
Note
Example of a request

24
 HTTPS API

POST /centralcontrol/camera/move

{
"direction": "up",
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

2). Camera focal length

Basic Information
Method: POST
Path: /centralcontrol/camera/zoom

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

UVC40, UVC86, SmartVision 40, AVHub.

 NOTE
1. Yealink RoomConnect and AVHub require the sn parameter to be included in the
Supported command.
Models 2. The sn parameter for MeetingBar A10/A40 is optional.
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
parameter can be optionally filled. However, if there are multiple cameras, the sn
parameter should be used to specify the correct camera for the intended operation.
4. UVC devices and SmartVision 40 do not require the sn parameter to be included.

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Camera focus direction:

[in,out,stop in: Zoom in
direction string Yes
] out: Zoom out
stop: Control camera to stop

25
 HTTPS API

Camera Unique Identifier

 NOTE
If the command is requested with the sn
sn string NULL No parameter, it means that the control is for
the device with the specified sn, otherwise
the control is for the first device in the
camera list.

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera/zoom

{
"direction": "in",
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

3). Get the camera position

Basic Information
Method: GET
Path: /centralcontrol/camera/position

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

UVC40, UVC86, SmartVision 40, AVHub.

 NOTE
1. Yealink RoomConnect and AVHub require the sn parameter to be included in the
Supported command.
Models 2. The sn parameter for MeetingBar A10/A40 is optional.
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
parameter can be optionally filled. However, if there are multiple cameras, the sn
parameter should be used to specify the correct camera for the intended operation.
4. UVC devices and SmartVision 40 do not require the sn parameter to be included.

26
 HTTPS API

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Camera Unique Identifier

 NOTE
If the command is requested with the sn
sn string NULL No
parameter, it means that the device with
the specified sn is acquired, otherwise the
first device in the camera list is acquired.

Return Value:

Name Typology Range of Values Parameter Description

x-axis coordinates

Reference range: [0~3360]

 NOTE
x double There are model differences, subject to actual
Limited by focal length
acquisition
value.

y-axis coordinates

Reference range: [0~1890]

 NOTE
y double There are model differences, subject to actual
Limited by focal length
acquisition
value.

Reference range: [-1890~0]

z double There are model differences, subject to actual Focal length
acquisition

Note
Example of a request

GET /centralcontrol/camera/position

{
"sn": "506607D117000009"
}

Response Example

27
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"x":1050.5,
"y":500,
"z":-280
}
}

4). Set camera position

Basic Information
Method: POST
Path: /centralcontrol/camera/position

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

UVC40, UVC86, SmartVision 40, AVHub.

 NOTE
1. Yealink RoomConnect and AVHub require the sn parameter to be included in the
Supported command.
Models 2. The sn parameter for MeetingBar A10/A40 is optional.
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
parameter can be optionally filled. However, if there are multiple cameras, the sn
parameter should be used to specify the correct camera for the intended operation.
4. UVC devices and SmartVision 40 do not require the sn parameter to be included.

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Camera Unique Identifier

 NOTE
If the command is requested with the sn
sn string NULL No
parameter, it means that the device
with the specified sn is acquired,
otherwise the first device in the camera
list is acquired.

28
 HTTPS API

x-axis coordinates

Reference
range: [0~3360]  NOTE
There are model Limited by the focal length value, the
x double differences, Yes input parameter is double type. Even if
subject to it is an integer value, it must have a
actual decimal point, otherwise it cannot be
acquisition executed successfully.

y-axis coordinates

Reference
range: [0~1890]  NOTE
There are model Limited by the focal length value, the
y double differences, Yes input parameter is double type. Even if
subject to it is an integer value, it must have a
actual decimal point, otherwise it cannot be
acquisition executed successfully.

Focus

 NOTE
Reference The input parameter is double type.
range: [-1890~0] Even if it is an integer value, it must
There are model have a decimal point, otherwise it
z double differences, Yes cannot be executed successfully.
subject to
actual
acquisition

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera/position

{
"x":1050.0,
"y":500.0,
"z":-280.0,
"sn": "506607D117000009"
}

29
 HTTPS API

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

5). Get the list of cameras

Basic Information
Method: GET
Path: /centralcontrol/camera/list

Supported MeetingBoard 65/86，MeetingEye 500/900，MeetingBar A10/A40，Yealink

Models RoomConnect，AVHub

Request Parameters:
Body:
NULL
Return Value:

Name Typology Parameter Description

sn-list string Camera sn list

Note
Example of a request

GET /centralcontrol/camera/list

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"sn-list":["803032E070000031"]
}
}

6). Get detailed information of the camera

Basic Information
Method: GET
Path: /centralcontrol/camera/detail

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect

30
 HTTPS API

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

sn string NULL Yes Camera unique identification

Return Value:

Name Typology Parameter Description

ip string Camera IP

mac string Camera mac address

name string Camera name

firmware string Camera software version

hardware string Camera hardware version

spec string Camera specifications

model string Camera models

sn string Camera sn

Note
Example of a request

GET /centralcontrol/camera/detail

{
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"ip":"[Link]",
"mac":"80:5E:C0:60:00:62",
"name":"Yealink UVC84 -1",
"firmware":"[Link]",
"hardware":"[Link].0.0.0",
"spec":"PTZ 12x Optical Zoom",
"model":"UVC84",
"sn":"506607D117000009"
}
}

7). Set camera to AI mode

Basic Information

31
 HTTPS API

Method: POST
Path: /centralcontrol/camera/ai-mode

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect,

UVC40, UVC86, SmartVision 40, AVHub

 NOTE
1. Yealink RoomConnect requires the 'sn' parameter to be included in the command.
MeetingBar A10/A40 has an optional sn parameter. A10 supports the following modes:
ptz, auto-frame, speaker-tracking, view-cropping, multi-screen, pip.
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
parameter can be optionally filled. However, if there are multiple cameras, the sn
parameter should be used to specify the correct camera for the intended operation.
4. UVC40 does not require the 'sn' parameter to be included. UVC40 supports the
Supported following modes: “ptz, auto-frame, speaker-tracking”.
Models 5. After connecting MeetingEye 500 to UVC86, the supported modes include: ptz, auto-
frame, speaker-tracking, smart-gallery, presenter-tracking. When connected to UVC84, it
supports the “ptz, auto-frame mode.
6. MeetingBoard 65/86 supports the following modes: ptz, auto-frame, speaker-tracking,
multi-screen, pip, smart-gallery, presenter-tracking
7.UVC86 does not require the sn parameter and only supports modes such as ptz, auto-
frame, speaker-tracking, multi-screen, presenter-tracking.
8. SmartVision 40 does not require the sn parameter and only supports modes such as
ptz, auto-frame, speaker-tracking, multi-screen, intelli-focus.
9. AVHub requires the sn parameter and only supports modes such as ptz, auto-frame,
speaker-tracking, multi-screen, presenter-tracking.

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Mode type:
ptz: Manual control
[ptz,auto-frame, auto-frame: Auto-framing
speaker-tracking, speaker-tracking: Speaker tracking
view-cropping, view-cropping: View cropping
multi-screen,smart- multi-screen: Multi-focus
type string Yes
gallery,pip,multi- smart-gallery: Smart gallery/Multi-flow
pip,presenter- mode
tracking,intelli- pip: Picture-in-picture
focus] multi-pip: Multi-split + Picture-in-picture
presenter-tracking: Presenter-tracking
intelli-focus: IntelliFocus

32
 HTTPS API

Camera Unique Identifier

 NOTE
If the command is requested with
sn string NULL No the sn parameter, it means that the
device with the specified sn is
acquired, otherwise the first device
in the camera list is acquired.

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera/ai-mode

{
"type": "ptz",
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

8). Preset Position Application

Basic Information
Method: POST
Path: /centralcontrol/camera/preset/recall

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect

 NOTE
1. Yealink RoomConnect and AVHub require the sn parameter to be included in the
command.
Supported
2. The sn parameter for MeetingBar A10/A40 is optional.
Models
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
parameter can be optionally filled. However, if there are multiple cameras, the sn
parameter should be used to specify the correct camera for the intended operation.
4. UVC devices and SmartVision 40 do not require the sn parameter to be included.

Request Parameters:

33
 HTTPS API

Body:

Name Typology Range of Values Compulsory Parameter Description

id int [1~99] Yes Preset position marker

sn string NULL No Camera unique identification

Return Value:
NULL
Note
Example of a request

1POST /centralcontrol/camera/preset/recall

{
"id": 1,
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

9 ). Preset position setting

Basic Information
Method: POST
Path: /centralcontrol/camera/preset

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect

 NOTE
1. Yealink RoomConnect and AVHub require the sn parameter to be included in the
command.
Supported
2. The sn parameter for MeetingBar A10/A40 is optional.
Models
3. For MeetingBoard 65/86 and MeetingEye 500/900, if there is only one camera, the sn
parameter can be optionally filled. However, if there are multiple cameras, the sn
parameter should be used to specify the correct camera for the intended operation.
4. UVC devices and SmartVision 40 do not require the sn parameter to be included.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

34
 HTTPS API

Preset position marker

id int [1~99] Yes

sn string NULL No Camera unique identification

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera/preset

{
"id": 1,
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

10). Non-sleep mode switch

Basic Information
Method: POST
Path: /centralcontrol/camera/keep-alive/switch

Yealink RoomConnect

Supported Models  NOTE

YRC requires the parameter sn to be included in the command.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Non-sleep mode status:

status string [on,off] Yes on: Enable
off: Disable

sn string NULL No camera unique identification

Return Value:
NULL
Note

35
 HTTPS API

Example of a request

POST /centralcontrol/camera/keep-alive/switch

{
"status: "on",
"sn": "506607D117000009"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

11). Video fence switch

Basic Information
Method: POST
Path: /centralcontrol/camera/video-fence/switch

Yealink RoomConnect

Supported Models  NOTE

YRC requires the parameter sn to be included in the command.

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Video fence status:

status string [on,off] Yes on: Open
off: Closed

sn string NULL No Camera unique identification

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera/video-fence/switch

{
"status: "on",
"sn": "506607D117000009"
}

36
 HTTPS API

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

12). Set multi-camera tracking

Basic Information
Method: POST
Path: /centralcontrol/camera/multi-camera-tracking-function

Supported Models AVHub

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Type:
close: Closed
[close,multi-camera-
multi-camera-intellifocus:
type string intellifocus, Yes
IntelliFocus
mic-camera-linkage]
mic-camera-linkage: Mic and
camera Linkage

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera/multi-camera-tracking-function

{
"type: "multi-camera-intellifocus"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

4. Display control

1). Get screen brightness

37
 HTTPS API

Basic Information
Method: GET
Path: /centralcontrol/screen/brightness

Supported Models MeetingBoard 65/86

Request Parameters:
Body:
NULL
Return Value:

Name Typology Range of Values Parameter Description

value int [1~255] Screen brightness value

Note
Example of a request

GET /centralcontrol/screen/brightness

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"value":60
}
}

2). Set screen brightness

Basic Information
Method: POST
Path: /centralcontrol/screen/brightness

Supported Models MeetingBoard 65/86

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

value int [1~255] Yes Screen brightness value

Return Value:
NULL
Note

38
 HTTPS API

Example of a request

POST /centralcontrol/screen/brightness

{
"value":60
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

3). Set screen input source

Basic Information
Method: POST
Path: /centralcontrol/screen/input-source

Supported Models MeetingBoard 65/86

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Switching input source type:

android: Android
type int [android,windows,hdmi-in] Yes
windows: Microsoft
hdmi-in: Hdmi input

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/screen/input-source

{
"type": "windows"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

39
 HTTPS API

5. Multi-mode control

1). Get the list of conference platforms

Basic Information
Method: GET
Path: /centralcontrol/meeting-platform/mode-list

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Supported  NOTE
Models The returned meeting platform is based on the meeting platform installed in the
device.

Request Parameters:
Body:
NULL
Return Value:

Name Typology Range of Values Parameter Description

List of meeting platforms for

devices:
ume: UME meeting
Reference range: yms: YMS meeting
mode-list string [ume,yms,zoom,general zoom: Zoom meeting
,tencent,feishu,byod] general: Yealink meeting
tencent: Tencent meeting
feishu: Feishu meeting
byod: BYOD mode.

Note
Example of a request

GET /centralcontrol/meeting-platform/mode-list

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"mode-list":["ume","yms","zoom"]
}
}

40
 HTTPS API

2). Set up the conference platform

Basic Information
Method: POST
Path: /centralcontrol/meeting-platform

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Device installed conference

platform:
ume: UME meeting
Reference range:
yms: YMS meeting
[ume,yms,zoom,
type string Yes zoom: ZOOM meeting
general,tencent,
general: Yealink meeting
feishu,byod]
tencent: Tencent meeting
feishu: Feishu meeting
byod: BYOD mode

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/meeting-platform

{
"type": "ume"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

3). Get current platform

Basic Information
Method: GET
Path: /centralcontrol/meeting-platform/current-mode

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

41
 HTTPS API

NULL
Return Value:

Name Typology Range of Values Parameter Description

name string NULL Current platform name

Note
Example of a request

GET /centralcontrol/meeting-platform/current-mode

{
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"name":"zoom"
}
}

6. Wireless Control

1). Enable Bluetooth

Basic Information
Method: POST
Path: /centralcontrol/bluetooth

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Bluetooth status:
status string [on,off] Yes off: Off
on: On

Return Value:
NULL
Note
Example of a request

42
 HTTPS API

POST /centralcontrol/bluetooth

{
"status": "on"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

7. Camera layout control

1). Set camera layout status

Basic Information
Method: POST
Path: /centralcontrol/camera-layout/switch

Supported Models Yealink RoomConnect

Request Parameters:
Body:

Name Typology Range of Values Compulsory Parameter Description

Camera layout status:

status string [on,off] Yes on: Enable
off: Disable

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera-layout/switch

{
"status": "on"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

43
 HTTPS API

2). Set camera layout type

Basic Information
Method: POST
Path: /centralcontrol/camera-layout/type

Yealink RoomConnect，MeetingEye 500

 NOTE
1. The type parameter for the MeetingEye 500 can have values of fullscreen, divide, and
1xN.
2. Yealink RoomConnect supports the type parameter with values of fullscreen, div2 to
div9, 1x1 to 1x8, and pip. When setting the fullscreen mode, you need to use the Set
Supported
Camera Layout/Camera Position feature to specify the camera with position 0 to apply
Models
the fullscreen mode.
[Link] Yealink RoomConnect includes the small-screen-position, small-screen-size,
main-screen-type, and second-screen-type parameters, and these four parameters only
apply to the Picture-in-Picture layout.
[Link] Yealink RoomConnect supports the sn parameter.
[Link] MeetingEye 500 supports the focus-camera parameter.

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Layout type:
fullscreen: Single full-screen layout
[fullscreen, div2~div9, div2~div9: Two-split~nine-split layout
type string 1x1~1x8, 1xN, divide, Yes divide: Equal split layout
pip] 1xN: 1+N layout
1x1~1x8: 1+1~1+8 layout
pip: PiP layout

The sub-camera sn parameter serves

sn string NULL No as a unique identifier (only Yealink
RoomConnect)

The unique identifier of the camera in

focus-
string NULL No the layout for the large image display.
camera
(only VCS device)

pip-param object NULL No Set of parameters related to PiP

44
 HTTPS API

Small screen position (only Yealink

RoomConnect) :
top-left: Top-left
bottom-left: Bottom-left
top-right: Top-right
>>small- [top-left,bottom-
bottom-right: Bottom-right
screen- string left,top-right,bottom- No
position right]
 NOTE
Only applicable to PiP layout
settings.

Size of the secondary window (only

Yealink RoomConnect):
one-fourth: One-fourth
one-ninth: One-ninth
>>small-
string [one-fourth,one-ninth] No
screen-size
 NOTE
Only applicable to PiP layout
settings.

Main camera view types (only Yealink

RoomConnect):
panorama: Panorama
close-up: Close-up view
>>main-
string [panorama,close-up] No
screen-type
 NOTE
Only applicable to PiP layout
settings.

Secondary camera view type (only

Yealink RoomConnect):
panorama: Panorama
auto-frame: Auto framing
>>second- [panorama,auto-
string No
screen-type frame]
 NOTE
Only applicable to PiP layout
settings.

Return Value:
NULL
Note
Example of a request (YRC)

45
 HTTPS API

POST /centralcontrol/camera-layout/type

{
"type": "fullscreen",
"sn":"8703018090000132",
"pip-param":
{
"small-screen-position":"top-left",
"small-screen-size":"one-fourth",
"main-screen-type":"panorama",
"second-screen-type":"auto-frame"
}
}

Example of a request (VCS)

POST /centralcontrol/camera-layout/type

{
"type": "fullscreen",
"focus-camera": "8703018090000132"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

3). Set up camera layout and camera position (MVC)

Basic Information
Method: POST
Path: /centralcontrol/camera-layout/position

Supported Models AVhub

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Yes（AVhub
position-list object NULL Getting a list of cameras
）

Yes（AVhub
>> sn Camera unique identification
）

Yes（AVhub Left coordinate of the camera layout screen

>> left [0~1920]
） display position

46
 HTTPS API

Yes（AVhub Top coordinate of the camera layout screen

>> top [0~1080]
） display position

Yes（AVhub
>> width [0~1920] Width of the camera layout screen display
）

Yes（AVhub
>> height [0~1080] Height of the camera layout screen display
）

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera-layout/position

{
"position-list":[
{
"sn":"806009E070000512",
"left":0,
"top":134,
"width":1440,
"height":810
},
{
"sn":"806007D120000442",
"left":1440,
"top":134,
"width":480,
"height":270
}
]
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

4). Setting up camera layout and camera position（YRC)

Basic Information
Method: POST
Path: /centralcontrol/camera-layout/position

Supported Models Yealink RoomConnect

Request Parameters:
Body:

47
 HTTPS API

Name Typology
Range of Values Compulsory Parameter Description

sn string NULL Yes Camera unique identification

position int [0~8] Yes Location identifier

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/camera-layout/position

{
"sn":"8703018090000132",
"position": 4
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

Layout positions follow left-to-right order, with equal divisions based on the maximum quantity of 1+N as a
reference:
Equal parts:

1+N：

48
 HTTPS API

5). Obtain camera layout type

Basic Information
Method: GET
Path: /centralcontrol/camera-layout/type

MeetingEye 500

Supported  NOTE
Models The value range for the type parameter of MeetingEye 500 is fullscreen, divide,
1xN.

Request Parameters:
Body:
NULL
Return Value:

Name Typology Range of Values Parameter Description

Layout type:
[fullscreen,1xN,d fullscreen: Single full-screen layout
type string
ivide] divide: Equal split layout
1xN: 1+N layout

focus- string NULL The unique identifier of the camera in the layout for the
camera large image display.

Note
Example of a request

GET /centralcontrol/camera-layout/type

{
}

Response Example

49
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"type":"fullscreen",
"focus-camera":"8703018090000132"
}
}

8. App control

1). Bring the App to the foretend

Basic Information
Method: POST
Path: /centralcontrol/app/start

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

Compulsor Parameter
Name Typology Range of Values
y Description

Retrieve the ID value from the app information App

id string list by referring to the basic information Yes package
document interface. name

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/app/start

{
"id": "[Link]"
}

Response Example
Error code description

50
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

parameter error:
{
"status":400
}

9. Other

1). Remote control button operation

Basic Information
Method: POST
Path: /centralcontrol/button

MeetingEye 500, UVC40

Supported Models  NOTE

UVC40 only supports "volume+" and "volume-".

Request Parameters:
Body:

Compulsor Parameter
Name Typology Range of Values
y Description

[power,F1,F2,F3,volume+,volume-
,zoom+,zoom-,up, Remote control
key string Yes
down,right,left,select,mute,back,call,delet button name
e,hangup,0~9*#]

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/button

{
"key": "left"
}

Response Example

51
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

2). Set the status of the meeting room to be dividable

Basic Information
Method: POST
Path: /centralcontrol/splitroom/status

Supported Models Yealink RoomConnect

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

sn string NULL Yes Requestor identification

Dividable Meeting Room status:

0: Disable Dividable Meeting Room function

 NOTE
When AVHub is already interconnected and
the Divisible Room function is enabled, if
you need to split or merge rooms, please
perform the split or merge operation on the
specific rooms via YRC. Do not directly
value int [0~3] Yes
disable the Divisible Room function. If you
disable the Divisible Room function, you will
need to disconnect the cables connected to
the AVHub CodeC port.

1: Standalone mode
2: Merged room
3: Master room

Return Value:
NULL
Note
Example of a request

52
 HTTPS API

POST /centralcontrol/splitroom/status

{
"sn":"8703018090000132",
"value": 1
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

Health services

Monitor the health status of devices and provide an alert mechanism.

1. Setting Log Sever Address

Basic Information
Method: POST
Path: /centralcontrol/system/log-server

UVC40, MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Supported  NOTE
Models 1. When the log server is turned off, other parameters can be omitted, otherwise must
be accompanied by ``
2. It is recommended to use parameters: facility(16), level(6), transport-type(0).

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Log server function switch:

enable int [0,1] Yes 1: Enable
0: Disable

53
 HTTPS API

Log storage device:

0: Kernel messages
1: User message
2: Mail system
3: System daemon
4: Security/authorization messages
5: Internal system generated information
6: Printing subsystem
7: Network messaging subsystem
8: UUCP subsystem
9: Clock daemon
10: Security/authorization messages
facility int [0-23] Yes 11: FTP daemon
12: NTP subsystem
13: Log audit
14: Log warning15: Clock daemon
16: For local use 0
17: For local use 1
18: For local use 2
19: For local use 3
20: For local use 4
21: For local use 5
22: For local use 6
23: For local use 7

level int [1-7] Yes Log level

Transmission type:
transport- 0: UDP
int [0,1,2] Yes
type 1: TCP
2: TLS

port int NULL Yes Ports

The server address for log

server string NULL Yes
synchronization.

Return Value:
NULL
Note
Example of a request

54
 HTTPS API

POST /centralcontrol/system/log-server

{
"enable": 1,
"server":"[Link]",
"port":514,
"facility":1,
"level":6,
"transport-type":0
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

2. Access system logs

Basic Information
Method: GET
Path: /centralcontrol/diagnostics/log

Supported Models Yealink RoomConnect, MeetingBoard 65 /86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:
NULL
Return Value:

Range of
Name Typology Parameter Description
Values

The file can only be obtained by actively triggering the

File stream file NULL
download

Note
Example of a request

GET /centralcontrol/diagnostics/log

{
}

Response Example

55
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

file

3. Network diagnosis

Basic Information
Method: POST
Path: /centralcontrol/diagnostics/network

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

ping ping command: ping -c num ip

action string Yes
traceroute traceroute command: traceroute -m num -I ip

Number of ping attempts; or maximum number

num int 1~30 Yes
of hops for traceroute tracking

ip string NULL Yes Target IP/domain

Return Value:

Name Typology Range of Values Parameter Description

result string NULL Executing statement returns content

Note
Example of a request

POST /centralcontrol/diagnostics/network

{
"action": "ping",
"num": 5,
"ip": "[Link]",
}

Response Example

Error code description

56
 HTTPS API

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"result": "PING [Link] ([Link]) 56(84) bytes of data.
64 bytes from [Link]: icmp_seq=1 ttl=64 time=0.164 ms
64 bytes from [Link]: icmp_seq=2 ttl=64 time=0.087 ms
64 bytes from [Link]: icmp_seq=3 ttl=64 time=0.091 ms

--- [Link] ping statistics ---

3 packets transmitted, 3 received, 0% packet loss, time 2051ms
rtt min/avg/max/mdev = 0.087/0.114/0.164/0.035 ms"
}
}

参数错误：
{
"status":400
}

4. Start or stop packet capture file upload

Basic Information
Method: POST
Path: /centralcontrol/diagnostics/packetcapture

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40.

 NOTE
1. If the captured packet data cache reaches 5M, only then can you use the GET method
to retrieve the captured packet data. The data will be cleared after using GET until
Supported
reaching 5M, then data will be available again.
Models
2. If real-time data retrieval is not required, it is recommended to stop capturing the
current collected packet data directly.
3. Capturing 5MB of packets is necessary because if the cache is too small, asynchronous
packet capturing may result in incomplete packet data.

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Filtering by
IP, port,
filter string protocol, No Filter condition
etc. is
possible.

57
 HTTPS API

wan:
currently Yes (start
interface string active capturing Interface name
network packets)
interface

0: Custom
1: SIP or
Yes (start
H245 or
filter-type int capturing Filter type; the filter takes effect if the value is 0.
H225
packets)
2: RTP
3: Not RTP

Packet capturing action; when stopping or

getting, there is no need to carry the above three
parameters.

 NOTE
1. It is recommended to send the get
start: start
command every 5 minutes after starting the
capturing
packet capturing to obtain the packet
packets
capture file. The packet capture files need
stop: stop
to be concatenated by yourself (you may
operation string capturing Yes
get empty files because the device side has
packets
not yet generated the file at this time); if
get: retrieve
more than 10 minutes have passed without
captured
getting, it is considered to abandon the
packet files
most recent packet capture file and stop
capturing.
2. When stopping, the device side responds
that the most recent file has not been
uploaded.

Return Value:
File:

Range of
Name Typology Parameter Description
Values

Packet Respond to get/stop operations; upload the packet capture file

file NULL
capture file itself without a file type extension.

Note
Example of a request

58
 HTTPS API

POST /centralcontrol/diagnostics/packetcapture

Start custom filter packet capture：

{
"filter": "tcp",
"interface": "wan",
"filter-type": 0,
"operation": "start"
}

Specify filter conditions to start packet capture:

{
"filter": "",
"interface": "wan",
"filter-type": 2,
"operation": "start"
}

Obtain packet capture file:

{
"operation": "get"
}

Stop packet capture:

{
"operation": "stop"
}

Response Example
When the start operation is successful, the response for capturing packets begins:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
}

When the get/stop operation is performed, the device end has already generated the file and sent it.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

file

5. Alarm

Basic Information
Method: GET
Path: /centralcontrol/diagnostics/alert

Supported Models MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40

59
 HTTPS API

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

critical:
severe
major: If severity is not specified, it defaults to
severity string No
primary critical.
minor: minor
all: all

1. Respond with a list of alarm events between

the from-time and the time the command is
sent.
Unit: seconds;
2. If from-time is not specified, default to
the earliest
from-time long No responding with a list of alarm events from the
time point is 7
last ten minutes.
days ago.
3. The timestamp refers to the number of
seconds elapsed between a certain moment
and "00:00:00" UTC on January 1, 1970.

Return Value:

Name Typology Range of Values Note

alert-list alert_list [] NULL List of device information

alert_list

Parameter
Name Typology Range of Values
Description

Disk slave disconnect: Accessory disconnected

Update Configuration failure: Configuration file update
failed
name string Event Name
Update Firmware failure: Firmware upgrade failed
Wireless microphone low battery: Low battery for
wireless microphone

critical: severe
severity string major: primary NULL
minor: minor

action-time long Unit: seconds Alarm timestamp

Device mac
mac string NULL
address

ip string NULL Device IP address

Note
Example of a request

60
 HTTPS API

GET /centralcontrol/diagnostics/alert

{
"severity": "major",
"from-time": 1701138336
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"status":200,
"data":
{
"alert-list": [
{
"name": "Update Configuration failure",
"severity": "major",
"action-time": 1701138336,
"mac": "00:00:00:00:00:00",
"ip": "[Link]"
},
{
"name": "Dsk slave disconnect",
"severity": "critical",
"action-time": 1701138336,
"mac": "00:00:00:00:00:00",
"ip": "[Link]"
}
]
}
}

Update service

Update the firmware of the device itself and its peripheral accessories.

1. Device upgrade

Basic Information
Method: POST
Path: /centralcontrol/upgrade/firmware/start

MeetingBoard 65/86, MeetingEye 500/900, MeetingBar A10/A40, Yealink RoomConnect

 NOTE
Supported 1. Only Yealink RoomConnect supports passing sn and device parameters. Fill in at least
Models one of the sn and device parameters.
2. In theory, only one of sn and device should be filled in. If both are filled in, only the sn
parameter will take effect.

61
 HTTPS API

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

sn string NULL No Device serial number for upgrade.

device string NULL No Upgraded device type

Firmware upgrade address (URL address or

url string NULL Yes
local path)

Upgrade time
time int -1~23 No -1: Upgrade immediatly
0~23: Upgrade time

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/upgrade/firmware/start

{
"sn":"803032E070000031",
"url": "[Link]
"time":-1
}

POST /centralcontrol/upgrade/firmware/start

{
"device":"uvc86",
"url": "[Link]
"time":-1
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

2. Device upgrade cancellation

Basic Information
Method: POST

62
 HTTPS API

Path: /centralcontrol/upgrade/firmware/cancel

Yealink RoomConnect

 NOTE
Supported
1. Fill in either SN or device theoretically. If both are filled in at the same time, only the
Models
SN parameter will take effect.
2. If neither SN nor device is filled in, all upgrades will be canceled.

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Device serial number that stopped

sn string NULL No
upgrading

device string NULL No Upgraded device type

Return Value:
NULL
Note
Example of a request

POST /centralcontrol/upgrade/firmware/cancel

{
"sn":"803032E070000031"
}

POST /centralcontrol/upgrade/firmware/cancel

{
"deivce":"uvc84"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200
}

3. Obtain upgrade status

Basic Information
Method: GET

63
 HTTPS API

Path: /centralcontrol/upgrade/firmware/status

Supported Models Yealink RoomConnect

Request Parameters:
Body:

Range of Compulsor
Name Typology Parameter Description
Values y

Get the serial number of the device in upgrade

sn string NULL Yes
status.

Return Value:

Name Typology Range of Values Parameter Description

Download status:
downloading: Downloading
[downloading,upgrading
status string upgrading: Upgrading
,success,fail]
success: Success
fail: Failed

Upgrade progress, return a normal value if

progress int 0~100
upgrading, otherwise return -1.

Note
Example of a request

GET /centralcontrol/upgrade/firmware/status

{
"sn":"803032E070000031"
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status":200,
"data":
{
"status":"upgrading",
"progress": 48
}
}

Configuration service

1. Configuration file update

This operation can provide configuration updates for switches such as WiFi /Wireless hotspot/Bluetooth.
asic Information

64
 HTTPS API

Method： POST
Path： /centralcontrol/config/update

Supported Models MeetingBoard 65/86，MeetingEye 500/900，MeetingBar A10/A40

Request Parameters:
Body:

Compulsor
Name Typology Range of Values Parameter Description
y

Trigger the default autop Configuration file address

url string Yes
update if empty (autop update address)

Return Value：
NULL
Note
Example of a request

POST /centralcontrol/config/update

{
"url": "[Link]
}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"status": 200
}

Device busy：
{
"status": 400
}

65