Mike Swanson
6942827391
Author: Mike Swanson Machine: Mikes-MacBook-Air.local Timestamp: 2026-07-09 14:52:07
23 KiB
Open API for Yealink Management Cloud Service V4X.pdf - Pages 141-160
Source: Open API for Yealink Management Cloud Service V4X.pdf Pages: 141-160 of 164 Chunk: 8
Open API for Yealink Management Cloud Service V4X
firmwareTyp Integer Firmware Type 0: Master Device 1: Accessory e downloadUrl String Download address version String Firmware version number supportMode String[] Supported model list ls siteId String Site ID Description String Firmware Description
Example Request
httpGET /v2/dm/firmwares/01d7ae1897f7418dad2d26609329be38 HTTP/1.1 Host: api.ymcs.yealink.com
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "id": "01d7ae1897f7418dad2d26609329be38", "name":"t54s firmware", "filename":"t54s.rom", "deviceType":1, "firmwareType":0, "downloadUrl":"https://resources.yiot.yealink.com/yiot-manager/api/v1/terminal/ resource/download/69847884d3be4327b86bffd0513c4572/1/ T46S(T48S,T42S,T41S)-66.86.0.15.rom", "version":"108.85.3.19", "supportModels":["SIP-T54S"], "siteId":"ee06cddee78948a298fc12565a35cdbe" }
10.1.3 Official Firmware List Request Method POST Request URL 141 / 164 Open API for Yealink Management Cloud Service V4X
/v2/dm/listOfficalFirmwares Body parameter
Parame Dat Re Description ter a qu Ty ire pe d 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. autoCou Boo No Whether to respond with the total count, it is nt lea recommended to set it to true when querying the first n page, and pass false for subsequent page turns. filter Filt Yes search parameters er
Filter object definition
Parameter Data Type Required Description modelId String Yes Firmware model 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 skip Long offset limit Long The maximum returned number. total Long Total quantity
142 / 164
Open API for Yealink Management Cloud Service V4X
data Firmware[] Firmware information array
Firmware object definition
Parameter Data Type Description id String Firmware ID name String Firmware name version String Firmware version number
Example Request
httpPOST /v2/dm/listOfficalFirmwares HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "skip": 0, "limit": 10, "autoCount": true, "filter":{ "modelId":"23a5da55f3534f84abc7956a9f183330" } }
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "01d7ae1897f7418dad2d26609329be38", "name":"t54s firmware", "version":"108.85.3.19" }] }
10.1.4 Push Firmware 143 / 164 Open API for Yealink Management Cloud Service V4X
Request Method POST Request URL /v2/dm/firmwares/{firmwareId}/push PATH parameter
parameter Data Type Required Description firmwareId String Yes Firmware ID
Body parameter
Paramet Data Requi Description er Type red deviceIds String[] Yes Device ID list, maximum length 200 deviceTy Integer Yes Device Type 1: Phone Device 3: Room pe Device
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
144 / 164
Open API for Yealink Management Cloud Service V4X
Parameter Data Type Description field String Error field msg String Error message.
Example Request
httpPOST /v2/dm/firmwares/09972370b360461d868e3e02f9cdec77/push HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "deviceIds": ["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"], "deviceType":1
}
Example Response
httpHTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8
{ "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"00099642675e4d4bb5e91fd9ae5ce585", "msg":"The resource does not exist or has been deleted" }] }
10.1.5 Push Official Firmware Request Method POST Request URL /v2/dm/officalFirmwares/{officalFirmwareId}/push PATH parameter
145 / 164
Open API for Yealink Management Cloud Service V4X
parameter Data Type Require Description d officalFirmwareId String Yes Official firmware ID
Body parameter
Paramet Data Requi Description er Type red deviceIds String[] Yes Device ID list, maximum length 200 deviceTy Integer Yes Device Type 1: Phone Device 3: Room pe Device
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
146 / 164
Open API for Yealink Management Cloud Service V4X
httpPOST /v2/dm/officalFirmwares/09972370b360461d868e3e02f9cdec77/push HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "deviceIds": ["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"], "deviceType":1 }
Example Response
httpHTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8
{ "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"00099642675e4d4bb5e91fd9ae5ce585", "msg":"The resource does not exist or has been deleted" }] }
11.Device Diagnosis User Manual: After successfully calling the diagnostic interface, obtain the diagnosisId from the response, and periodically poll (recommended every 10 seconds) to check the diagnostic status. If the status response is successful (status=success), you can obtain the download URL for the diagnostic file from the response and retrieve the file using the URL. 11.1 Get the list of network port types Request Method GET Request URL /v2/dm/devices/{deviceId}/networkInterfaces 147 / 164 Open API for Yealink Management Cloud Service V4X
Path parameter
parameter Data Type Required Description deviceId String Yes The device ID.
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 data String[] Type list
Example Request
httpGET /v2/dm/devices/8d07a56207074d26b61026099625b9e2/networkInterfaces HTTP/1.1 Host: api.ymcs.yealink.com
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
["wan","wlan0","ext0"]
11.2 Start packet capture Request Method PUT Request URL /v2/dm/devices/{deviceId}/startPacketCapture
148 / 164
Open API for Yealink Management Cloud Service V4X
Path parameter
parameter Data Type Required Description deviceId String Yes The device ID.
Body parameter
Pa Da Re Description ra ta qu me Ty ir te p e r e d ne St Ye Network port, the specific value is obtained from the network tw ri s interface type list, generally includes wan (Wide Area Network or ng port), ext0 (external telephone line port), wlan0 (Wireless kI Local Area Network port), default is wan. nt er fa ce ty In N Packet capture type, 0 – Custom, 1 – SIP or H245 or H225, 2 – pe te o RTP, 3 – Not RTP ge r fil St N Capture filtering information, this value is only needed when te ri o the capture type = 0. r ng du In Ye Capture maximum duration, unit seconds, range: 180~3600 ra te s ti ge on r
HTTP status code
Code Description 200 Operation successful, see response parameters. 400 Client parameter exception
149 / 164
Open API for Yealink Management Cloud Service V4X
401 Authentication failed 500 Server exception
Response parameters
parameter Data Type Description diagnosisId String Diagnosis Session ID
Example Request
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/startPacketCapture HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "networkInterface":"wan", "type":0， "duration":180
}
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687", }
11.3 End Capture Request Method PUT Request URL /v2/dm/devices/{deviceId}/stopPacketCapture Path parameter
parameter Data Type Required Description 150 / 164 Open API for Yealink Management Cloud Service V4X
deviceId String Yes The device ID.
Body parameter
parameter Data Type Required Description diagnosisId String Yes Diagnosis ID
HTTP status code
Code Description 204 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception
Example Request
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/stopPacketCapture HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687" }
Example Response
httpHTTP/1.1 204
11.4 screenshots Request Method PUT Request URL /v2/dm/devices/{deviceId}/captureScreen Path parameter
151 / 164
Open API for Yealink Management Cloud Service V4X
parameter Data Type Required Description deviceId String Yes The device ID.
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 diagnosisId String Diagnosis ID
Example Request
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/captureScreen HTTP/1.1 Host: api.ymcs.yealink.com
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687", }
11.5 Export system log Request Method PUT Request URL /v2/dm/devices/{deviceId}/exportSyslog
152 / 164
Open API for Yealink Management Cloud Service V4X
Path parameter
parameter Data Type Required Description deviceId String Yes The device ID.
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 diagnosisId String Diagnosis ID
Example Request
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/exportSyslog HTTP/1.1 Host: api.ymcs.yealink.com
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687", }
11.6 Export Configuration File Request Method PUT Request URL
153 / 164
Open API for Yealink Management Cloud Service V4X
/v2/dm/devices/{deviceId}/exportConfig Path parameter
parameter Data Type Required Description deviceId String Yes The device ID.
HTTP status code
Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed 500 Server exception
Example Request
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/exportConfig HTTP/1.1 Host: api.ymcs.yealink.com
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687", }
11.7 Detect Network \u2014 ping Request Method PUT Request URL /v2/dm/devices/{deviceId}/ping Path parameter
parameter Data Type Required Description 154 / 164 Open API for Yealink Management Cloud Service V4X
deviceId String Yes The device ID.
Body parameter
Paramet Data Requir Description er Type ed host String Yes IP/domain name to ping times Integer Yes Number of times, minimum 1, maximum 30
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 diagnosisId String Diagnosis ID
Example Request
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/ping HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "host":"www.google.com", "times":1 }
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
155 / 164
Open API for Yealink Management Cloud Service V4X
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687", }
11.8 Network Detection \u2014 traceroute Request Method PUT Request URL /v2/dm/devices/{deviceId}/traceroute Path parameter
parameter Data Type Required Description deviceId String Yes The device ID.
Body parameter
Paramet Data Requir Description er Type ed host String Yes IP/domain name to traceroute times Integer Yes Number of times, minimum 1, maximum 30
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 diagnosisId String Diagnosis ID
Example Request
156 / 164
Open API for Yealink Management Cloud Service V4X
httpPUT /v2/dm/devices/8d07a56207074d26b61026099625b9e2/traceroute HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "host":"www.google.com", "times":1 }
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "diagnosisId": "0006d62003684754b11c09c5d94ea687", }
11.9 Query Diagnostic Status Request Method GET Request URL /v2/dm/diagnosis/{diagnosisId}/status Path parameter
parameter Data Type Required Description diagnosisId String Yes Diagnosis ID
HTTP status code
Code Description 200 Operation successful, see response parameters. 400 Client parameter exception 401 Authentication failed 500 Server exception
Response parameters
157 / 164
Open API for Yealink Management Cloud Service V4X
Para Data Description mete Type r devic Strin Device ID eId g statu Strin Diagnosis Status: inprogress: In Progress success: Success s g failure: Failure url Strin File download address, available when status = success. g
Example Request
httpGET /v2/dm/diagnosis/0006d62003684754b11c09c5d94ea687/status HTTP/1.1 Host: api.ymcs.yealink.com
Example Response
httpHTTP/1.1 200 Content-Type: application/json;charset=UTF-8
{ "deviceId": "0006d62003684754b11c09c5d94ea687", "status":"success", "url":https://yealinkussdev.blob.core.windows.net/single-12/allinone-10.122.131.12-uss%2F40ae7a sv=2021-06-08&spr=https%2Chttp&se=2024-01-10T02%3A06%3A01Z&sr=b&sp=r&sig=JHco76T2o4i }
12.Alarm Management 12.1 Alarm List Request Method POST Request URL /v2/dm/listAlarms Body parameter
Pa Da Re Description 158 / 164 Open API for Yealink Management Cloud Service V4X
ra ta qu me Ty ir te p e r e d sk Lo N Number of skipped records, default is 0 ip ng o li Lo N Maximum number of records to retrieve, default is 10, mi ng o maximum is 500. t au Bo N Whether to respond with the total count, it is recommended to ol o to set it to true when querying the first page, and pass false Co ea for subsequent page turns. un n t fil Fil N search parameters te te o r r
Filter object definition
Par Dat Re Description ame a qu ter Typ ire e d mac Stri No Device MAC fuzzy search keyword, maximum length 17, ng supports with : or -, such as 00:15:65:bb:b1:a9 dev Int No Device Type, 1: Phone Device 3: Room Device, leave blank iceT ege for all ype r
HTTP status code
Code Description 200 Operation successful 400 Client parameter exception 401 Authentication failed
159 / 164
Open API for Yealink Management Cloud Service V4X
500 Server exception
Response parameters
Parameter Data Type Description skip Long offset limit Long The maximum returned number. total Long Total quantity data Alarm[] Alarm information array
Alarm object definition
Parameter Data Description Type id String Alarm ID event String Alarm Event Name level Integer Alarm Level 1-Minor 2-Major 3-Critical mac String MAC model String model ip String IP siteName String site status Integer Processing status 1-active 2-solve 3-ignore firstAlarmTim Long First alarm time e lastAlarmTime Long Last alarm time
Example Request
httpPOST /v2/dm/listAlarms HTTP/1.1 Host: api.ymcs.yealink.com Content-Type: application/json
{ "skip": 0, "limit": 10, "autoCount": true, "filter":{ 160 / 164