亿联中控第三方控制 API（HTTPS）
CT100
CT100
首页
亿联中控第三方控制 API（HTTPS）
时间：2026-06-08浏览量：30
Control APIs
使用Control APIs
Control APIs允许开发者访问和操作中控下的资源，包括但不限于：查询设备、路由等操作。本章将叙述如何正确的调用Control API。
开发前须知
在调用Control APIs前，确保已获取API访问凭证，并加入到请求Header中。
UC APIs协议说明
Protocols: HTTPS
Host: api.yealink.com
prefix: open/api
Version: v1
Accepts: application/json
Responds With: application/json
Host 将根据中控服务部署而定，这里的值为示例。
请求地址：
所有的 API 请求都必须通过 HTTPS 发出。请求的基础 URL 格式为：{{Protocols}}://{{Host}}/{{prefix}}/{{Version}} + 具体API请求地址。
例如：https：//api.yealink.com/open/api/v1/auth/token
请求参数：
每次请求 API 时，均需提供 3 个请求头参数，具体如下：
参数
参数类型
数据类型
是否必需
描述
Token
Header
String
是
访问凭证
timestamp
Header
String
是
时间戳，从 1970年1月1日0点0分0秒开始到现在的毫秒数
nonce
Header
String
是
随机数，一般为uuid
请求头部示例：
Token: [ACCESS TOKEN]
timestamp: 1568693976264
nonce: 097e0ac619ba41f68f16f1955787feb
获取Token
请求方法：
POST
请求地址：
/open/api/v1/auth/clientToken
请求参数：
参数
参数类型
数据类型
是否必需
描述
Authorization
Header
String
是
数值为base64(clientId:clientSecret)
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
token
String
鉴权token，用户使用其他HTTP接口访问时header需带上此token用于鉴权，有效时长默认一小时
expireTime
Integer
token过期时间
请求消息示例：
POST /open/api/v1/auth/clientToken HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
Authorization: ZmY3MTI4Y2JiZGIyNGRiMzk3ZTUxODY0YWM3ZDY2YmM6ZmY3MTI4Y2JiZGIyNGRiMzk3ZTUxODY0YWM3ZDZra2s=
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDg5NDMzOTk3NjYsImlkIjoiNmZiZTI3NWMtY2I3OS1mOTMyLTA5MWMtNDU5OTJlMTI0OTQ4Iiwic3ViIjoidXNlciBpbmZvIn0.MY9pi2thAFDfnnZzeu3y3YJEb9H-2wy8E_PIAYrrSNs",
"expireTime": 1709176978079
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Content-Type: application/json' -H 'Authorization: ZmY3MTI4Y2JiZGIyNGRiMzk3ZTUxODY0YWM3ZDY2YmM6ZmY3MTI4Y2JiZGIyNGRiMzk3ZTUxODY0YWM3ZDZra2s=' 'https://api.yealink.com/open/api/v1/auth/clientToken'
更新Token
请求方法：
PUT
请求地址：
/open/api/v1/auth/token
请求参数：
参数
参数类型
数据类型
是否必需
描述
token
Header
String
是
鉴权token，可在失效前用于更新token，默认一小时
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
token
String
鉴权token，用户使用其他HTTP接口访问时header需带上此token用于鉴权，有效时长默认一小时
expireTime
Integer
token过期时间
请求消息示例：
PUT /open/api/v1/auth/token HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDg5NDMzOTk3NjYsImlkIjoiNmZiZTI3NWMtY2I3OS1mOTMyLTA5MWMtNDU5OTJlMTI0OTQ4Iiwic3ViIjoidXNlciBpbmZvIn0.MY9pi2thAFDfnnZzeu3y3YJEb9H-2wy8E_PIAYrrSNs
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDg5NDMzOTk3NjYsImlkIjoiNmZiZTI3NWMtY2I3OS1mOTMyLTA5MWMtNDU5OTJlMTI0OTQ4Iiwic3ViIjoidXNlciBpbmZvIn0.MY9pi2thAFDfnnZzeu3y3YJEb9H-2wy8E_PIAYrrSNs",
"expireTime": 1709176978079
},
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/auth/token'
基础API
获取设备信息列表
请求方法：
POST
请求地址：
/open/api/v1/devices/filter
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
id
String
设备UUID
name
String
设备名称
model
String
设备型号
type
String
设备类型
encoder-编码器
decoder-解码器
ipAddress
String
设备IP地址
macAddress
String
macAddress
status
String
设备状态
online-在线
offline-离线
请求消息示例：
POST /open/api/v1/devices/filter HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"list": [
{
"id": "EN300_249ad85a5be2",
"name": "未命名设备",
"tag": "tag",
"model": "SIP-T41S",
"type": "encoder",
"ipAddress": "117.28.234.38",
"macAddress": "249ad85a5be2",
"firmwareVersion": "10.0.0.1",
"groupId": "4586020e-6064-9bd0-1d6b-8de77405dd26",
"status": "online",
"createTime": 1705565760894,
"modifyTime": 1705565760894
}
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/devices/filter'
设置音视频路由
请求方法：
PUT
请求地址：
/open/api/v1/routing/av/real
请求参数：
参数
参数类型
数据类型
是否必需
描述
transmitterMac
Body
String
是
transmitter的MAC地址
transmitterIp
Body
String
是
transmitter的IP地址
receiverMac
Body
String
是
receiver的MAC地址
receiverIp
Body
String
是
receiver的IP地址
signal
Body
String
是
路由信号
Audio/Video-音视频
Video-视频
Audio-音频
action
Body
String
是
区分signal操作是开启还是关闭
open-开启
close-关闭
对同个设备设置音视频路由时，路由信号及路由开关的设置需保持一定的时间间隔，待路由在设备中进行生效。
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
id
String
设备UUID
name
String
设备名称
model
String
设备型号
type
String
设备类型，encoder-编码器、decoder-解码器
ipAddress
String
设备IP地址
macAddress
String
macAddress
status
String
设备状态，online-在线、offline-离线
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>=0
data
object
null
error
object
错误信息
errorCode
Integer
错误码
msg
string
错误描述
reason
string
失败原因
请求消息示例：
GET /open/api/v1/routing/av/real HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"transmitterMac": "2458122467125568",
"transmitterIp": "10.60.26.16",
"receiverMac": "5468124591324158",
"receiverIp": "10.60.26.17",
"signal": "Audio/Video",
"action":"open"
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"transmitterMac": "44DBD2DDE744", "receiverMac": "44DBD2CAD485", "signal": "Audio/Video", "action": "open"}' 'https://api.yealink.com/open/api/v1/routing/av/real'
获取音视频路由状态
请求方法：
GET
请求地址：
/open/api/v1/routing/av/real
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
groupId
String
分组ID
transmitterMac
String
transmitter的MAC地址
receiverMac
String
receiver的MAC地址
signal
String
路由信号，Audio/Video-音视频、Video-视频、Audio-音频
请求消息示例：
GET /open/api/v1/routing/av/real HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"groupId": "6581020e-6064-9bd0-1d6b-8de77400dfg5",
"routing": [
{
"transmitterMac": "2458122467125568",
"receiverMac": "5468124591324158",
"signal": "Audio"
},
{
"transmitterMac": "3458122467125569",
"receiverMac": "5468124591324158",
"signal": "Video"
}
]
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/routing/av/real'
获取音视频预置路由列表
请求方法：
GET
请求地址：
/open/api/v1/routing/av/preset
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
groupId
String
分组ID
presetId
String
路由ID
name
String
路由名称
enable
Integer
是否应用
0-未应用
1-应用
请求消息示例：
GET /open/api/v1/routing/av/preset HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"groupId": "6581020e-6064-9bd0-1d6b-8de77400dfg5",
"presetList": [
{
"presetId": "1e65020e-6064-9bd0-1d6b-8de77400c884",
"name": "路由名称",
"enable": 1,
"createTime": 1705565760894,
"modifyTime": 1705565760894,
"routing": [
{
"transmitterId": "88fd020e-6064-9bd0-1d6b-8de77400hdkv",
"transmitterName": "Encoder1",
"transmitterType": "encoder",
"transmitterMac": "2458122467125568",
"transmitterIp": "10.60.26.16",
"receiverId": "96fg020e-6064-9bd0-1d6b-8de77400025g",
"receiverName": "Decoder1",
"receiverType": "decoder",
"receiverMac": "5468124591324158",
"receiverIp": "10.60.26.17",
"signal": "Audio/Video"
}
]
}
]
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/routing/av/preset'
调用音视频预置路由
请求方法：
PUT
请求地址：
/open/api/v1/routing/av/preset/enable
请求参数：
参数
参数类型
数据类型
是否必需
描述
presetId
Body
String
是
路由ID
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
presetId
String
路由ID
请求消息示例：
PUT /open/api/v1/routing/av/preset/enable HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"presetId": "1e65020e-6064-9bd0-1d6b-8de77400c884"
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"presetId": "1e65020e-6064-9bd0-1d6b-8de77400c884"
},
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"presetId": "1e65020e-6064-9bd0-1d6b-8de77400c884"}' 'https://api.yealink.com/open/api/v1/routing/av/preset/enable'
设置USB路由(包含取消路由)
请求方法：
PUT
请求地址：
/open/api/v1/routing/usb
请求参数：
参数
参数类型
数据类型
是否必需
描述
mode
Body
String
是
usb路由模式
Follow Video
Manual
routing
Body
Array
是
路由列表
transmitterMac
Body
String
是
传输器MAC地址
transmitterIp
Body
String
是
传输器IP地址
receiverMac
Body
String
是
接收器MAC地址
receiverIp
Body
String
是
接收器IP地址
signal
Body
String
是
信号类型
Audio/Video
None(取消路由)
对同个设备设置USB路由时，路由信号的设置需保持一定的时间间隔，待路由在设备中进行生效。
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>0
请求消息示例：
PUT /open/api/v1/routing/usb HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"mode": "Manual",
"routing": [
{
"transmitterMac": "2458122467125568",
"transmitterIp": "10.60.26.16",
"receiverMac": "5468124591324158",
"receiverIp": "10.60.26.17",
"signal":"Audio/Video"
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"mode": "Manual", "routing": [{"transmitterMac": "2458122467125568", "transmitterIp": "10.60.26.16", "receiverMac": "5468124591324158", "receiverIp": "10.60.26.17", "signal": "Audio/Video"}]}' 'https://api.yealink.com/open/api/v1/routing/usb'
获取USB路由列表
请求方法：
GET
请求地址：
/open/api/v1/routing/usb
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
groupId
String
分组ID
mode
String
usb路由模式
Follow Video
Manual
routing
Array
路由列表
transmitterMac
String
传输器MAC地址
receiverMac
String
接收器MAC地址
请求消息示例：
GET /open/api/v1/routing/usb HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"groupId": "6581020e-6064-9bd0-1d6b-8de77400dfg5",
"mode": "Manual",
"routing": [
{
"transmitterMac": "2458122467125568",
"receiverMac": "5468124591324158"
}
]
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v2/v1/routing/usb'
切换USB路由模式
请求方法：
PUT
请求地址：
/open/api/v1/routing/usb/mode
请求参数：
参数
参数类型
数据类型
是否必需
描述
mode
Body
String
是
usb路由模式
Follow Video
Manual
routing
Body
Array
是
路由列表
transmitterMac
Body
String
是
传输器MAC地址
transmitterIp
Body
String
是
传输器IP地址
receiverMac
Body
String
是
接收器MAC地址
receiverIp
Body
String
是
接收器IP地址
从Manual切换到Follow Video模式时，"routing"为[]即可；从Follow Video切换到Manual时，需要把当前的路由("routing")都带上。
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
groupId
String
分组ID
请求消息示例：
PUT /open/api/v1/routing/usb/mode HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"mode": "Manual",
"routing": [
{
"transmitterMac": "2458122467125568",
"transmitterIp": "10.60.26.16",
"receiverMac": "5468124591324158",
"receiverIp": "10.60.26.17"
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"groupId": "6581020e-6064-9bd0-1d6b-8de77400dfg5"
},
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"mode": "Follow Video","routing":[]}' 'https://api.yealink.com/open/api/v1/routing/usb/mode'
获取自动路由列表
请求方法：
GET
请求地址：
/open/api/v1/routing/av/auto
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
groupId
String
分组ID
autoId
String
自动路由组ID
name
String
路由名称
enable
Integer
是否应用，0-未应用、1-应用
请求消息示例：
GET /open/api/v1/routing/av/auto?groupId=6581020e-6064-9bd0-1d6b-8de77400dfg5 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"groupId": "6581020e-6064-9bd0-1d6b-8de77400dfg5",
"autoList": [
{
"autoId": "1e65020e-6064-9bd0-1d6b-8de77400c884",
"name": "路由名称",
"enable": 1,
"createTime": 1705565760894,
"modifyTime": 1705565760894,
"routing": [
{
"transmitterId": "88fd020e-6064-9bd0-1d6b-8de77400hdkv",
"transmitterName": "Encoder1",
"transmitterType": "encoder",
"transmitterMac": "2458122467125568",
"transmitterIp": "10.60.26.16",
"receiverId": "96fg020e-6064-9bd0-1d6b-8de77400025g",
"receiverName": "Decoder1",
"receiverType": "decoder",
"receiverMac": "5468124591324158",
"receiverIp": "10.60.26.17",
"enable": 1
}
]
}
]
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/routing/av/auto'
启动自动路由
请求方法：
PUT
请求地址：
/open/api/v1/routing/av/auto/enable
请求参数：
参数
参数类型
数据类型
是否必需
描述
autoId
Body
String
是
自动路由组ID
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
autoId
String
自动路由组ID
请求消息示例：
PUT /open/api/v1/routing/av/auto/enable HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"autoId": "1e65020e-6064-9bd0-1d6b-8de77400c884"
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"autoId": "1e65020e-6064-9bd0-1d6b-8de77400c884"
},
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"autoId": "1e65020e-6064-9bd0-1d6b-8de77400c884"}' 'https://api.yealink.com/open/api/v1/routing/av/auto/enable'
关闭自动路由
请求方法：
PUT
请求地址：
/open/api/v1/routing/av/auto/disable
请求参数：
参数
参数类型
数据类型
是否必需
描述
autoId
Body
String
是
自动路由组ID
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>0
请求消息示例：
PUT /open/api/v1/routing/av/auto/disable HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"autoId": "1e65020e-6064-9bd0-1d6b-8de77400c884"
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"autoId": "1e65020e-6064-9bd0-1d6b-8de77400c884"}' 'https://api.yealink.com/open/api/v1/routing/av/auto/disable'
编解码器API
设置编解码器视频矩阵配置
请求方法：
PUT
请求地址：
/open/api/v1/devices/video/input
请求参数：
参数
参数类型
数据类型
是否必需
描述
batchConfig
Body
Object
否
批量配置参数
batchList
Body
Array
否
批量配置的设备UUID列表
singleList
Body
Array
否
单台配置参数列表
model
Body
String
是
设备类型
mac
Body
String
是
设备mac地址
ENCODER
lanOut
Body
String
是
LAN out输出视频源，默认为usb-c
lanOutSwitching
Body
String
是
LAN out自动转换的开关
1-开启
0-关闭
loopOut
Body
String
是
Loop out输出视频源，默认为usb-c
loopOutSwitching
Body
String
是
Loop out自动转换的开关
1-开启
0-关闭
DECODER
autoSwitching
Body
Integer
是
功能自动切换的开关
1-开启
0-关闭
hdmiOut
Body
String
是
可选：
none
hdmi input1
lan in
videoCaptureOut
Body
String
是
可选：
none
hdmi input1
lan in
批量配置只能用于同类型设备的配置。
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>0
请求消息示例：
PUT /open/api/v1/devices/video/input HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
Encoder:
{
"batchConfig": {
"lanOut": "usb-c",
"lanOutSwitching": 1,
"loopOut": "usb-c",
"loopOutSwitching": 1
},
"batchList": [{"model": "EN300", "mac": "44DBD2DDE744"}],
"singleList": [
{
"model": "EN300",
"mac": "44DBD2DDE744",
"lanOut": "usb-c",
"lanOutSwitching": 1,
"loopOut": "usb-c",
"loopOutSwitching": 1
}
]
}
Decoder:
{
"batchConfig": {
"hdmiOut": "lan in",
"videoCaptureOut": "none",
"autoSwitching": 1
},
"batchList": [{"model": "DE300", "mac": "44DBD2DDE744"}],
"singleList": [
{
"model": "DE300",
"mac": "44DBD2DDE744",
"hdmiOut": "lan in",
"videoCaptureOut": "none",
"autoSwitching": 1
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"singleList": ["id": "DE300_256ad85a5ab5", "hdmiOut": "lan in", "videoCaptureOut": "none", "autoSwitching": 1]}' 'https://api.yealink.com/open/api/v1/devices/video/input'
获取编解码器视频矩阵配置handleId
请求方法：
POST
请求地址：
/open/api/v1/devices/video/input
请求参数：
参数
参数类型
数据类型
是否必需
描述
list
Body
Array
是
设备UUID列表
model
Body
String
是
设备型号
mac
Body
String
是
设备mac地址
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
handleId
String
获取编解码器配置的任务请求ID
请求消息示例：
POST /open/api/v1/devices/video/input HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"list": [
{
"model": "EN300",
"mac": "44DBD2DDE744"
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"handleId": "45865020e-6064-9bd0-1d6b-8de77400c88"
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"list": [{"model": "EN300", "mac": "44DBD2DDE744"}]}' 'https://api.yealink.com/open/api/v1/devices/video/input'
获取编解码器视频矩阵配置
请求方法：
GET
请求地址：
/open/api/v1/devices/video/input
请求参数：
参数
参数类型
数据类型
是否必需
描述
handleId
Path
String
是
获取编解码器配置的任务请求ID
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
reqFinish
Integer
请求是否结束标志
1-停止请求
0-继续请求
id
String
设备UUID
type
String
设备类型
encoder-编码器
decoder-解码器
name
String
设备名
model
String
设备型号
ENCODER
lanOut
String
LAN out输出视频源，默认为usb-c
lanOutSwitching
String
LAN out自动转换的开关
1-开启
0-关闭
loopOut
String
Loop out输出视频源，默认为usb-c
loopOutSwitching
String
Loop out自动转换的开关
1-开启
0-关闭
DECODER
autoSwitching
Integer
功能自动切换的开关
1-开启
0-关闭
hdmiOut
String
可选
none
hdmi input1
lan in
videoCaptureOut
String
可选
none
hdmi input1
lan in
批量获取的场景下，数据获取可能需要一定时间，reqFinish若返回0则说明数据还未收集完毕，需等待一段时间后再度发送本次请求，直到reqFinish返回1标志结束。
请求消息示例：
GET /open/api/v1/devices/video/input?handleId=45865020e-6064-9bd0-1d6b-8de77400c88 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"reqFinish": 1,
"list": [
{
"id": "EN300_249ad85a5be2",
"type": "encoder",
"name": "VP59",
"model": "VP59",
"lanOut": "usb-c",
"lanOutSwitching": 1,
"loopOut": "usb-c",
"loopOutSwitching": 1
},
{
"id": "DE300_249ad85a5be2",
"type": "decoder",
"name": "VP59",
"model": "VP59",
"hdmiOut": "lan in",
"videoCaptureOut": "none",
"autoSwitching": 1
}
]
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/devices/video/input?handleId=45865020e-6064-9bd0-1d6b-8de77400c88'
设置编解码器USB配置
请求方法：
PUT
请求地址：
/open/api/v1/devices/advanced/usb
请求参数：
参数
参数类型
数据类型
是否必需
描述
usbMode
Body
String
是
USB信号模式
transmitter
receiver
usbSwitch
Body
String
是
本地USB Switch模式
follow_video
manual
usbHost
Body
String
是
手动manual模式下选择
usb_host1
usb_host2
usb_c
list
Body
Array
是
设备列表
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>0
请求消息示例：
PUT /open/api/v1/devices/advanced/usb HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"usbMode": "transmitter",
"usbSwitch": "manual",
"usbHost": "usb_c",
"list": [
{
"model": "EN300",
"mac": "44DBD2DDE744"
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"usbMode": "transmitter","usbSwitch": "manual","usbHost": "usb_c","list": [{"model": "EN300", "mac": "44DBD2DDE744"}]}' 'https://api.yealink.com/open/api/v1/devices/advanced/usb'
获取编解码器USB配置
请求方法：
GET
请求地址：
/open/api/v1/devices/advanced/usb
请求参数：
参数
参数类型
数据类型
是否必需
描述
model
Path
String
是
设备型号
mac
Path
String
是
设备Mac地址
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
usbMode
String
USB信号模式
transmitter
receiver
usbSwitch
String
本地USB Switch模式
follow_video
manual
usbHost
String
手动manual模式下选择，
usb_host1
usb_host2
usb_c
请求消息示例：
GET /open/api/v1/devices/advanced/usb?model=EN300&mac=44DBD2DDE744 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"usbMode": "transmitter",
"usbSwitch": "manual",
"usbHost": "usb_c"
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/devices/advanced/usb?model=EN300&mac=44DBD2DDE744'
设置编解码器Audio配置
请求方法：
PUT
请求地址：
/open/api/v1/devices/audio
请求参数：
参数
参数类型
数据类型
是否必需
描述
batchConfig
Body
Object
否
批量配置参数
batchList
Body
Array
否
批量配置的设备UUID列表
singleList
Body
Array
否
单台配置参数列表
model
Body
String
是
设备类型
mac
Body
String
是
设备mac地址
analogAudioOut
Body
Integer
是
HDMI Out音频输出开关
1-开启
0-关闭
audioOutVolume
Body
String
是
音频输出音量，0-100
批量配置只能用于同类型设备的配置。
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>0
请求消息示例：
PUT /open/api/v1/devices/audio HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"batchConfig": {
"analogAudioOut": 1,
"audioOutVolume": 80
},
"batchList": [
{
"model": "EN300",
"mac": "44DBD2DDE744"
}
],
"singleList": [
{
"model": "EN300",
"mac": "44DBD2DDE744",
"analogAudioOut": 1,
"audioOutVolume": 80
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"singleList": [{"model": "EN300", "mac": "44DBD2DDE744", "analogAudioOut": 1, "audioOutVolume": 80}]}' 'https://api.yealink.com/open/api/v1/devices/audio'
获取编解码器Audio配置handleId
请求方法：
POST
请求地址：
/open/api/v1/devices/audio
请求参数：
参数
参数类型
数据类型
是否必需
描述
list
Body
Array
是
设备列表
model
Body
String
是
设备型号
mac
Body
String
是
设备mac地址
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
handleId
String
获取编解码器配置的任务请求ID
请求消息示例：
POST /open/api/v1/devices/audio HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"list": [
{
"model": "DE300",
"mac": "249AD85A5BE2"
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"handleId": "45865020e-6064-9bd0-1d6b-8de77400c88"
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"list": [{"model": "DE300", "mac": "249AD85A5BE2"}]}' 'https://api.yealink.com/open/api/v1/devices/audio'
获取编解码器Audio配置
请求方法：
GET
请求地址：
/open/api/v1/devices/audio
请求参数：
参数
参数类型
数据类型
是否必需
描述
handleId
Path
String
是
获取编解码器配置的任务请求ID
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
reqFinish
Integer
请求是否结束标志，1-停止请求、0-继续请求
id
String
设备UUID
type
String
设备类型，encoder-编码器、decoder-解码器
name
String
设备名
model
String
设备型号
analogAudioOut
Integer
HDMI Out音频输出开关，1-开启、0-关闭
audioOutVolume
Integer
音频输出音量，0-100
批量获取的场景下，数据获取可能需要一定时间，reqFinish若返回0则说明数据还未收集完毕，需等待一段时间后再度发送本次请求，直到reqFinish返回1标志结束。
请求消息示例：
GET /open/api/v1/devices/audio?handleId=45865020e-6064-9bd0-1d6b-8de77400c88 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"reqFinish": 1,
"list": [
{
"id": "DE300_249ad85a5be2",
"type": "decoder",
"name": "VP59",
"model": "VP59",
"analogAudioOut": 1,
"audioOutVolume": 80
}
]
},
"error": null
}
CURL命令示例：
curl -XGET -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' 'https://api.yealink.com/open/api/v1/devices/audio?handleId=45865020e-6064-9bd0-1d6b-8de77400c88'
调试编解码器显示控制
请求方法：
PUT
请求地址：
/open/api/v1/devices/advanced/displayControl/test
请求参数：
参数
参数类型
数据类型
是否必需
描述
controlType
Body
String
是
控制类型，默认CEC
Off
CEC
RS232
IR
commandType
Body
String
是
命令类型
hex
ascii
commandString
Body
String
是
命令字符串
serial
Body
String
是
RS232串口的配置，如果当前controlType不是RS232，则不用传
- baudRate
Body
Integer
是
波特率，默认9600
300
600
1200
2400
4800
9600
19200
38400
57600
115200
- dataBits
Body
Integer
是
数据位，7-8
- parity
Body
String
是
校验位
none
odd
even
- stopBits
Body
Integer
是
停止位，1-2
- flowControl
Body
String
是
控制流
none
dtr_dsr
rts_cts
xon_xoff
list
Body
Array
是
设备列表
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Integer
操作失败返回-1，成功返回>=0
请求消息示例：
PUT /open/api/v1/devices/advanced/displayControl/test HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"controlType": "RS232",
"commandType": "hex",
"commandString": "xxxxxxxxxxx",
"serial": {
"baudRate": 9600,
"dataBits": 8,
"parity": "none",
"stopBits": 1,
"flowControl": "none"
},
"list": [
{
"model": "EN300",
"mac": "44DBD2DDE744"
}
]
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"controlType": "IR","commandType": "hex","commandString": "xxxxxxxxxxx","list": [{"model": "EN300", "mac": "44DBD2DDE744"}]}' 'https://api.yealink.com/open/api/v1/devices/advanced/displayControl/test'
界面设计API
房间查询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/spaces/page
请求参数：
参数
参数类型
数据类型
是否必需
描述
skip
Body
Int
是
跳过的数据条数
limit
Body
Int
是
限制显示的数据条数
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
total
Int
数据总数
id
String
项目ID
name
String
项目名称
createTime
Long
创建时间戳，13位
modifyTime
Long
修改时间戳，13位
请求消息示例：
POST /open/api/v1/ctrl/spaces/page HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"skip": 0,
"limit": 50
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"skip": 0,
"limit": 50,
"total": 1,
"list": [
{
"id": "6a670bb3-65b1-44c0-ba90-d63f733aa188",
"name": "Space name 1",
"createTime": 1453490850853,
"modifyTime": 1453507911225
}
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"skip":0,"limit":50}' 'https://api.yealink.com/open/api/v1/ctrl/spaces/page'
预设动作集列表查询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/macros/page
请求参数：
参数
参数类型
数据类型
是否必需
描述
skip
Body
Int
是
跳过的数据条数
limit
Body
Int
是
限制显示的数据条数
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
total
Int
数据总数
id
String
预设动作集ID
name
String
预设动作集名称
请求消息示例：
POST /open/api/v1/ctrl/macros/page HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"skip": 0,
"limit": 50
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"skip": 0,
"limit": 50,
"spaceId": "04cc5185-d823-497b-97ae-dc1d934bd6f0",
"total": 1,
"list": [
{
"id": "6a670bb3-65b1-44c0-ba90-d63f733aa188",
"name": "Macro name 1"
}
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"skip":0,"limit":50}' 'https://api.yealink.com/open/api/v1/ctrl/macros/page'
自动化列表查询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/monitors/page
请求参数：
参数
参数类型
数据类型
是否必需
描述
skip
Body
Int
是
跳过的数据条数
limit
Body
Int
是
限制显示的数据条数
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
total
Int
数据总数
id
String
自动化ID
name
String
自动化名称
enable
Boolean
启用状态
请求消息示例：
POST /open/api/v1/ctrl/monitors/page HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"skip": 0,
"limit": 50
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"skip": 0,
"limit": 50,
"spaceId": "04cc5185-d823-497b-97ae-dc1d934bd6f0",
"total": 1,
"list": [
{
"id": "6a670bb3-65b1-44c0-ba90-d63f733aa188",
"name": "Monitor name 1",
"enable": true
}
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"skip":0,"limit":50}' 'https://api.yealink.com/open/api/v1/ctrl/monitors/page'
自动路由列表查询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/autoRoutings/page
请求参数：
参数
参数类型
数据类型
是否必需
描述
skip
Body
Int
是
跳过的数据条数
limit
Body
Int
是
限制显示的数据条数
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
total
Int
数据总数
id
String
自动化ID
name
String
自动化名称
enable
Boolean
启用状态
请求消息示例：
POST /open/api/v1/ctrl/autoRoutings/page HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"skip": 0,
"limit": 50
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 1,
"data": {
"skip": 0,
"limit": 50,
"spaceId": "04cc5185-d823-497b-97ae-dc1d934bd6f0",
"total": 1,
"list": [
{
"id": "6a670bb3-65b1-44c0-ba90-d63f733aa188",
"name": "AutoRouting name 1",
"enable": true
}
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"skip":0,"limit":50}' 'https://api.yealink.com/open/api/v1/ctrl/autoRoutings/page'
调用预设动作集
请求方法：
POST
请求地址：
/open/api/v1/ctrl/macro/invoke
请求参数：
参数
参数类型
数据类型
是否必需
描述
macroId
Body
String
是
预设动作集ID
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Int
大于等于0则成功
请求消息示例：
POST /open/api/v1/ctrl/macro/invoke HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"macroId": "29c29caa-19c1-43f2-a628-84211c6402f9"
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"macroId":"29c29caa-19c1-43f2-a628-84211c6402f9"}' 'https://api.yealink.com/open/api/v1/ctrl/macro/invoke'
禁用/启用自动化
请求方法：
PUT
请求地址：
/open/api/v1/ctrl/monitor
请求参数：
参数
参数类型
数据类型
是否必需
描述
monitorId
Body
String
是
自动化ID
enable
Body
Boolean
是
自动化启用/禁用状态，true为启用
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Int
大于等于0则成功
请求消息示例：
PUT /open/api/v1/ctrl/monitor HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"monitorId": "29c29caa-19c1-43f2-a628-84211c6402f9",
"enable": true
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"monitorId":"29c29caa-19c1-43f2-a628-84211c6402f9","enable":true}' 'https://api.yealink.com/open/api/v1/ctrl/monitor'
禁用/启用自动路由
请求方法：
PUT
请求地址：
/open/api/v1/ctrl/autoRouting
请求参数：
参数
参数类型
数据类型
是否必需
描述
autoRoutingId
Body
String
是
自动化ID
enable
Body
Boolean
是
自动化启用/禁用状态，true为启用
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
ret
Int
大于等于0则成功
请求消息示例：
PUT /open/api/v1/ctrl/autoRouting HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"autoRoutingId": "29c29caa-19c1-43f2-a628-84211c6402f9",
"enable": true
}
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": null,
"error": null
}
CURL命令示例：
curl -XPUT -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '{"autoRoutingId":"29c29caa-19c1-43f2-a628-84211c6402f9","enable":true}' 'https://api.yealink.com/open/api/v1/ctrl/autoRouting'
预设动作集变更轮询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/macro/longPolling
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
204
请重新发起长轮询
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
list
array(Int)
预设动作集发生改变的所有房间ID
请求消息示例：
POST /open/api/v1/ctrl/macro/longPolling HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": {
"list": [
"Space Id - 1",
"Space Id - 2"
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '' 'https://api.yealink.com/open/api/v1/ctrl/macro/longPolling'
自动化变更轮询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/monitor/longPolling
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
204
请重新发起长轮询
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
list
array(Int)
自动化发生改变的所有房间ID
请求消息示例：
POST /open/api/v1/ctrl/monitor/longPolling HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": {
"list": [
"Space Id - 1",
"Space Id - 2"
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '' 'https://api.yealink.com/open/api/v1/ctrl/monitor/longPolling'
自动路由变更轮询
请求方法：
POST
请求地址：
/open/api/v1/ctrl/autoRouting/longPolling
HTTP状态码：
返回值
描述
200
操作成功，详见返回参数
204
请重新发起长轮询
400
客户端传参异常
401
鉴权失败
500
服务端异常
返回参数：
参数
数据类型
描述
list
array(Int)
自动路由发生改变的所有房间ID
请求消息示例：
POST /open/api/v1/ctrl/autoRouting/longPolling HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
返回消息示例：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"ret": 0,
"data": {
"list": [
"Space Id - 1",
"Space Id - 2"
]
},
"error": null
}
CURL命令示例：
curl -XPOST -H 'Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -d '' 'https://api.yealink.com/open/api/v1/ctrl/autoRouting/longPolling'
这篇文章解决了您的问题了吗？
是
否
