Files

Mike Swanson 6942827391 sync: auto-sync from Mikes-MacBook-Air.local at 2026-07-09 14:52:07

Author: Mike Swanson
Machine: Mikes-MacBook-Air.local
Timestamp: 2026-07-09 14:52:07

2026-07-09 14:52:17 -07:00

23 KiB

Raw Blame History

Open API for Yealink Management Cloud Service V4X.pdf - Pages 81-100

Source: Open API for Yealink Management Cloud Service V4X.pdf Pages: 81-100 of 164 Chunk: 5

Open API for Yealink Management Cloud Service V4X

Parameter Data Description Type id String Sub-site Configuration ID name String Sub-site configuration name, length 64 siteId String Site ID deviceType Integer Device Type 1: Phone Device modelId String Model ID Description String Description, length 256

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPOST /v2/dm/listSiteConfigs HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "skip": 0, "limit": 10, "autoCount": true }

Example Response

httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8

{ "skip": 0, "limit": 10, "total": 1,

                                                                            81 / 164

Open API for Yealink Management Cloud Service V4X

"data":[{ "id": "8b7f1739ad6d4a578267d09b53a262a3", "name": "site1 config2", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "Description":"test2" }] }

4.2.6 Push Subsite Configuration Request Method POST Request URL /v2/dm/siteConfigs/{configId}/push Path parameter

parameter Data Type Required Description configId String Yes The configuration ID.

HTTP status code

Code Description 204 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPOST /v2/dm/siteConfigs/8b7f1739ad6d4a578267d09b53a262a3/push HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 204

                                                                           82 / 164

Open API for Yealink Management Cloud Service V4X

4.3 Phone Group Configuration Management 4.3.1 Add Group Configuration Request Method POST Request URL /v2/dm/groupConfigs Body parameter

Paramete Data Requi Description r Type red name String Yes Group configuration name, length 64 deviceGro String Yes Device Group ID upId deviceTyp Integer Yes Device Type 1: Phone Device e modelId String No Model ID, leaving it blank indicates all models content String No Configuration file content Descriptio String No Description, length 256 n

Response parameters

Parameter Data Type Description id String Group Configuration ID

HTTP status code

Code Description 201 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

                                                                                   83 / 164

Open API for Yealink Management Cloud Service V4X

httpPOST /v2/dm/groupConfigs HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "name": "group config", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "content": "lang.wui=English\nlang.gui=English", "Description":"test" }

Example Response

httpHTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8

{ "id": "8faa39e34929425f85b4cd9925a2bbcb" }

4.3.2 Edit Group Configuration Request Method PATCH Request URL /v2/dm/groupConfigs/{configId} Path parameter

Parameter Data Type Required Description configId String Yes Group Configuration ID

Body parameter

Paramete Data Requi Description r Type red name String Yes Group configuration name, length 64 deviceGro String Yes Device Group ID

                                                                              84 / 164

Open API for Yealink Management Cloud Service V4X

upId deviceTyp Integer Yes Device Type 1: Phone Device e modelId String No Model ID, leaving it blank indicates all models content String No Configuration file content Descriptio String No Description, length 256 n

HTTP status code

Code Description 204 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPATCH /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "name": "group config2", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "content": "lang.wui=English\nlang.gui=English", "Description":"test2" }

Example Response

httpHTTP/1.1 204

4.3.3 Delete Group Configuration Request Method 85 / 164 Open API for Yealink Management Cloud Service V4X

POST Request URL /v2/dm/delGroupConfigs Body parameter

Parame Data Requi Description ter Type red configI String[] Yes Group configuration ID list, maximum length ds 200

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

Parameter Data Description Type total Integer Delete total count successCount Integer Total number of successful deletions. failureCount Integer The total number of failures. errors OpError[] Error message.

OpError object

Parameter Data Type Description field String Error field msg String Error message.

Example Request

httpDELETE /v2/dm/delGroupConfigs HTTP/1.1 Host: api.ymcs.yealink.com 86 / 164 Open API for Yealink Management Cloud Service V4X

Content-Type: application/json

{ "configIds": ["8faa39e34929425f85b4cd9925a2bbcb","e33b8f25247e45de84dd4c74503b241a"] }

Example Response

httpHTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8

{ "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"e33b8f25247e45de84dd4c74503b241a", "msg":"The resource does not exist or has been deleted" }] }

4.3.4 Group Configuration Details Request Method GET Request URL /v2/dm/groupConfigs/{configId} Path parameter

Parameter Data Type Required Description configId String Yes Group Configuration ID

Response parameters

Parameter Data Description Type id String Group Configuration ID name String Group configuration name, length 64

                                                                             87 / 164

Open API for Yealink Management Cloud Service V4X

deviceGroupId String Group ID deviceType Integer Device Type 1: Phone Device modelId String Model ID content String Configuration file content Description String Description, length 256

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpGET /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8

{ "id": "8faa39e34929425f85b4cd9925a2bbcb", "name": "group config2", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "content": "lang.wui=English\nlang.gui=English", "Description":"test2" }

4.3.5 Group Configuration List Request Method POST

                                                                      88 / 164

Open API for Yealink Management Cloud Service V4X

Request URL /v2/dm/listGroupConfigs Body parameter

Para Data Requ Description mete Type ired r skip Long No Number of skipped records, default is 0 limit Long No Maximum number of records to retrieve, default is 10, maximum is 500. auto Bool No Whether to return the total number of records Coun ean t

Response parameters

Parameter Data Type Description skip Long offset limit Long The maximum returned number. total Long Total data volume data Config[] Config information array

Config definition

Parameter Data Description Type id String Group Configuration ID name String Group configuration name, length 64 deviceGroupId String Group ID deviceType Integer Device Type 1: Phone Device modelId String Model ID Description String Description, length 256

HTTP status code

Code Description 89 / 164 Open API for Yealink Management Cloud Service V4X

200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPOST /v2/dm/listGroupConfigs HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "skip": 0, "limit": 10, "autoCount": true }

Example Response

httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8

{ "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "8faa39e34929425f85b4cd9925a2bbcb", "name": "group config2", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "Description":"test2" }] }

4.3.6 Push Group Configuration Request Method POST

                                                    90 / 164

Open API for Yealink Management Cloud Service V4X

Request URL /v2/dm/groupConfigs/{configId}/push Path parameter

parameter Data Type Required Description configId String Yes The configuration ID.

HTTP status code

Code Description 204 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPOST /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb/push HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 204

4.4 Conference Room Equipment Configuration Management 4.4.1 Save Device Configuration Request Method PUT Request URL /v2/dm/rooms/deviceConfigs Body parameter

Parameter Data Type Required Description deviceId String Yes Device ID content String Yes cfg file content 91 / 164 Open API for Yealink Management Cloud Service V4X

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

Parameter Data Type Description id String The device configuration ID.

Example Request

httpPUT /v2/dm/rooms/deviceConfigs HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "deviceId": "8d07a56207074d26b61026099625b9e2", "content": "lang.wui=English\nlang.gui=English" }

Example Response

httpHTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8

{ "id": "d916a46b4557464c87c278cb37477bef" }

4.4.2 Device Configuration Details Request Method GET Request URL /v2/dm/rooms/deviceConfigs/{configId} 92 / 164 Open API for Yealink Management Cloud Service V4X

Path parameter

Paramete Data Type Require Description r d configId String Yes The device configuration ID.

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

Parameter Data Type Description id String The device configuration ID. content String Configuration ID

Example Request

httpGET /v2/dm/rooms/deviceConfigs/e33b8f25247e45de84dd4c74503b241a HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8

{ "id": "8d07a56207074d26b61026099625b9e2", "content":"#!version:1.0.0.1\naccount.1.codec.g722.enable=1" }

4.4.3 Push Device Configuration Request Method POST 93 / 164 Open API for Yealink Management Cloud Service V4X

Request URL /v2/dm/rooms/deviceConfigs/{configId}/push Path parameter

parameter Data Type Required Description configId String Yes The configuration ID.

HTTP status code

Code Description 204 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPOST /v2/dm/rooms/deviceConfigs/e33b8f25247e45de84dd4c74503b241a/push HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 204

4.4 Conference Room Equipment Configuration Management 4.4.1 Save Device Configuration Request Method PUT Request URL /v2/dm/rooms/deviceConfigs Body parameter

Parameter Data Type Required Description deviceId String Yes Device ID

                                                                               94 / 164

Open API for Yealink Management Cloud Service V4X

content String Yes cfg file content

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

Parameter Data Type Description id String The device configuration ID.

Example Request

httpPUT /v2/dm/rooms/deviceConfigs HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "deviceId": "8d07a56207074d26b61026099625b9e2", "content": "lang.wui=English\nlang.gui=English" }

Example Response

httpHTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8

{ "id": "d916a46b4557464c87c278cb37477bef" }

4.4.2 Device Configuration Details Request Method GET

                                                                           95 / 164

Open API for Yealink Management Cloud Service V4X

Request URL /v2/dm/rooms/deviceConfigs/{configId} Path parameter

Paramete Data Type Require Description r d configId String Yes The device configuration ID.

HTTP status code

Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

Parameter Data Type Description id String The device configuration ID. content String Configuration ID

Example Request

httpGET /v2/dm/rooms/deviceConfigs/e33b8f25247e45de84dd4c74503b241a HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8

{ "id": "8d07a56207074d26b61026099625b9e2", "content":"#!version:1.0.0.1\naccount.1.codec.g722.enable=1" }

4.4.3 Push Device Configuration 96 / 164 Open API for Yealink Management Cloud Service V4X

Request Method POST Request URL /v2/dm/rooms/deviceConfigs/{configId}/push Path parameter

parameter Data Type Required Description configId String Yes The configuration ID.

HTTP status code

Code Description 204 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception

Example Request

httpPOST /v2/dm/rooms/deviceConfigs/e33b8f25247e45de84dd4c74503b241a/push HTTP/1.1 Host: api.ymcs.yealink.com

Example Response

httpHTTP/1.1 204

5.RPS management 5.1 RPS Device Management 5.1.1 Add Device Request Method POST Request URL /v2/rps/devices

                                                                         97 / 164

Open API for Yealink Management Cloud Service V4X

Body parameter

Parameter Data Requ Description Type ired mac String Yes Device MAC, minimum length 12, maximum length 17 sn String Yes SN code, maximum length 128 serverId String No Server ID uniqueServe String No Server address, maximum length 256 rUrl authName String No Authentication username, maximum length 128 password String No Authentication password, maximum length 128 remark String No Note, maximum length 256

HTTP status code

Code Description 201 Operation successful, see response parameters. 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

parameter Data Type Description id String The device ID. mac String The device MAC address. sn String The group ID. serverId String The server ID. uniqueServerUrl String The server address. authName String The username for authentication. remark String The remark.

                                                                              98 / 164

Open API for Yealink Management Cloud Service V4X

Example Request

httpPOST /v2/rps/devices HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "mac":"001565bbb1a9", "sn":"1106312113402006", "serverId":"ba7c7b13ed114a5fa6f12063ea9dff41", "remark":"SeakeerDevice", "authName":"Seakeer", "password":"654321"

}

Example Response

httpHTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8

{ "id": "8d07a56207074d26b61026099625b9e2", "mac":"001565bbb1a9", "sn":"1106312113402006", "serverId":"ba7c7b13ed114a5fa6f12063ea9dff41", "remark":"SeakeerDevice", "authName":"Seakeer",

}

5.1.2 Batch Add Devices Note: A maximum of 100 items at a time. Request Method POST Request URL /v2/rps/addDevices Body parameter

                                                99 / 164

Open API for Yealink Management Cloud Service V4X

HTTP status code

Code Description 200 Operation successful, see response parameters. 400 Client parameter exception 401 Authentication failed 500 Server exception

Response parameters

Parameter Data Type Description total Integer The total number of batch additions. successCoun Integer The total number of successful additions. t failureCount Integer The total number of failures. errors AddError[] Error message.

AddError object

parameter Data Type Description mac String The device MAC address.

                                                                                100 / 164

23 KiB Raw Blame History

Open API for Yealink Management Cloud Service V4X.pdf - Pages 81-100

23 KiB

Raw Blame History