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 61-80

Source: Open API for Yealink Management Cloud Service V4X.pdf Pages: 61-80 of 164 Chunk: 4

Open API for Yealink Management Cloud Service V4X

"siteId":"0006d62003684754b11c09c5d94ea687", "remark":"test"

}

Example Response

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

{ "id": "e33b8f25247e45de84dd4c74503b241a", "registerInfo": "2552", "username": "2552", "serverAddress": "ume.yealink.com", "accountType": 0, "createTime": 1698052518923 }

3.2 Edit SIP Account Request Method PATCH Request URL /v2/dm/sipAccounts/{accountId} Path parameter

parameter Data Type Required Description accountId String Yes Account

Body parameter

Parameter Data Requir Description Type ed registerNam String Yes Name，maximum length 128 e username String Yes Username, maximum length 128 password String Yes Password, maximum length 128

                                                                               61 / 164

Open API for Yealink Management Cloud Service V4X

displayName String No Display name, maximum length 128 label String No Label, maximum length 128 sipServer1 SipServe Yes sip server 1 address r sipServer2 SipServe No sip server 2 address r remark String No Note, maximum length 512 siteId String No Site ID to be assigned

SipServer object definition

Parameter Data Type Description host String Server address, maximum length 256 port Integer Server port, 0~65535

HTTP status code

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

Example Request

httpPATCH /v2/dm/sipAccounts/e33b8f25247e45de84dd4c74503b241a HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json

{ "registerName": "2553", "username": "2552", "password": "******", "label": "2552", "displayName": "2552", "sipServer1": { "host": "ume.yealink.com", "port":5061

                                                                              62 / 164

Open API for Yealink Management Cloud Service V4X

}, "siteId":"0006d62003684754b11c09c5d94ea687", "remark":"test"

}

Example Response

httpHTTP/1.1 204

3.3 Account List Request Method POST Request URL /v2/dm/listAccounts Body parameter

Par Dat Req Description ame a uir ter Ty ed pe skip Lo No Number of skipped records, default is 0 ng limit Lo No Maximum number of records to retrieve, default is 10, ng maximum is 500. aut Boo No Whether to respond with the total count, it is oCo lea recommended to set it to true when querying the first unt n page, and pass false for subsequent page turns. filte Filt No search parameters r er

Filter object definition

Paramete Data Type Require Description r d username String No Username fuzzy search keyword

                                                                                63 / 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 skip Long offset limit Long The maximum returned number. total Long Total quantity data Account[] Account information array

Account object definition

Parameter Data Description Type id String account id username String username registerInfo String Registration Information serverAddress String Server address accountType Integer Account type, 0: SIP, 1: H323, 2: SFB remark String Note createTime Long Creation time

Example Request

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

{ "skip": 0, "limit": 20, 64 / 164 Open API for Yealink Management Cloud Service V4X

"autoCount": true, "filter":{ "username":"2552" } }

Example Response

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

{ "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "e33b8f25247e45de84dd4c74503b241a", "registerInfo": "2552", "username": "h323", "accountType": 1, "createTime": 1698052518923 }] }

3.4 Delete Account Request Method POST Request URL /v2/dm/delAccounts Body parameter

Paramete Data Requir Description r Type ed accountId String[] Yes Account ID list, maximum length 200 s

HTTP status code

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

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

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

{ "accountIds": ["e33b8f25247e45de84dd4c74503b241a","2d3e77b736e240eabf25aa1f5448aa0c"] }

Example Response

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

{ "total": 2,

                                                                             66 / 164

Open API for Yealink Management Cloud Service V4X

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

4.Configuration Management 4.1 Telephone Device Configuration Management 4.1.1 Device Configuration List Request Method POST Request URL /v2/dm/listDeviceConfigs 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 filter Filter No filter condition

Filter object definition

Par Dat Re Description ame a qu ter Typ ire e d ma Stri No Device MAC fuzzy search keyword, maximum length 17, c ng supports with : or -, such as 00:15:65:bb:b1:a9 67 / 164 Open API for Yealink Management Cloud Service V4X

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 object definition

parameter Data Description Type id String The primary key ID. name String The configuration name. modelId String The device model ID. Description String Enter a description for the configuration.

HTTP status code

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

Example Request

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

{ "skip": 0, "limit": 10, "autoCount": true, "filter":{ "mac":"001565bbb1a9" } 68 / 164 Open API for Yealink Management Cloud Service V4X

}

Example Response

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

{ "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "8d07a56207074d26b61026099625b9e2", "name":"my config", "modelId":"61e659e4d78d42ebada88ef1eb751b64", "Description":"my t54s config" }] }

4.1.2 Add Device Configuration Request Method POST Request URL /v2/dm/deviceConfigs Body parameter

Paramete Data Requ Description r Type ired deviceId Strin Yes Device ID g content Strin Yes cfg file content g autoPush Bool No Whether to automatically push this device ean configuration when the phone device is powered on for the first time or restored to factory settings, true: yes false: no

HTTP status code 69 / 164 Open API for Yealink Management Cloud Service V4X

Code Description 201 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

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

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

Example Response

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

{ "id": "d916a46b4557464c87c278cb37477bef" }

4.1.3 Delete Device Configuration Request Method POST Request URL /v2/dm/delDeviceConfigs

                                                                      70 / 164

Open API for Yealink Management Cloud Service V4X

Body parameter

Parame Data Requi Description ter Type red configI String[] Yes Device 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

OpError object

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

Example Request

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

{ "configIds":

                                                                               71 / 164

Open API for Yealink Management Cloud Service V4X

["e33b8f25247e45de84dd4c74503b241a","8d07a56207074d26b61026099625b9e2"] }

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.1.4 Device Configuration Details Request Method GET Request URL /v2/dm/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 72 / 164 Open API for Yealink Management Cloud Service V4X

parameter Data Description Type id String The device configuration ID. name String The configuration name. modelId String The device model ID. content String Configuration Content Description String Enter a description for the configuration.

Example Request

httpGET /v2/dm/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", "name":"my config", "modelId":"61e659e4d78d42ebada88ef1eb751b64", "content":"#!version:1.0.0.1\naccount.1.codec.g722.enable=1" "Description":"my t54s config" }

4.1.5 Push Device Configuration Request Method POST Request URL /v2/dm/deviceConfigs/{configId}/push Path parameter

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

HTTP status code 73 / 164 Open API for Yealink Management Cloud Service V4X

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

Example Request

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

Example Response

httpHTTP/1.1 204

4.2 Telephone Substation Configuration Management 4.2.1 Add Sub-site Configuration Request Method POST Request URL /v2/dm/siteConfigs Body parameter

Paramet Data Requi Description er Type red name String Yes Sub-site configuration name, length 64 siteId String Yes Site ID deviceTy Integer Yes Device Type 1: Phone Device pe modelId String No Model ID, leaving it blank indicates all models content String No Configuration file content Descripti String No Description, length 256 on

                                                                                  74 / 164

Open API for Yealink Management Cloud Service V4X

HTTP status code

Code Description 201 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

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

{ "name": "site1 config", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "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": "8b7f1739ad6d4a578267d09b53a262a3" }

4.2.2 Edit Subsite Configuration Request Method

                                                                      75 / 164

Open API for Yealink Management Cloud Service V4X

PATCH Request URL /v2/dm/siteConfigs/{configId} Path parameter

Parameter Data Type Required Description configId String Yes Subsite configuration ID.

Body parameter

HTTP status code

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

Example Request

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

{

                                                                                  76 / 164

Open API for Yealink Management Cloud Service V4X

"name": "site1 config2", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "content": "lang.wui=English\nlang.gui=English", "Description":"test2" }

Example Response

httpHTTP/1.1 204

4.2.3 Delete Subsite Configuration Request Method POST Request URL /v2/dm/delSiteConfigs Body parameter

Param Data Requi Description eter Type red configI String[] Yes Sub-site 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 77 / 164 Open API for Yealink Management Cloud Service V4X

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

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

{ "configIds": ["8b7f1739ad6d4a578267d09b53a262a3","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.2.4 Subsite Configuration Details Request Method GET

                                                                             78 / 164

Open API for Yealink Management Cloud Service V4X

Request URL /v2/dm/siteConfigs/{configId} Path parameter

Parameter Data Type Required Description configId String Yes Subsite configuration ID.

HTTP status code

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

Response parameters

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 content String Configuration file content Description String Description, length 256

Example Request

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

Example Response

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

                                                                             79 / 164

Open API for Yealink Management Cloud Service V4X

{ "id": "8b7f1739ad6d4a578267d09b53a262a3", "name": "site1 config2", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "modelId":"db249ca8f83f425baeda09214288d0a9", "content": "lang.wui=English\nlang.gui=English", "Description":"test2" }

4.2.5 Substation Configuration List Request Method POST Request URL /v2/dm/listSiteConfigs Body parameter

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 80 / 164

23 KiB Raw Blame History Unescape Escape

Open API for Yealink Management Cloud Service V4X.pdf - Pages 61-80

23 KiB

Raw Blame History