# Open API for Yealink Management Cloud Service V4X.pdf - Pages 121-140

**Source:** Open API for Yealink Management Cloud Service V4X.pdf
**Pages:** 121-140 of 164
**Chunk:** 7

---

Open API for Yealink Management Cloud Service V4X



 siteName                        String        Affiliated site
 quality                         String        Call Quality Good, Poor, Bad
 startTime                       long          The call start timestamp.
 endTime                         long          The call end timestamp.
 callerURI                       String        Caller URL, fromURI
 calleeURI                       String        Called URL, toURI
 duration                        long          Call duration (ms)

Example Request

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

  {
  "skip":0,
  "limit":10,
  "filter":{
  "startTime":1700876148000,
  "endTime":1703468148329,
  "siteIds":["126b25122362470daca91ae8ad038a27"]
  }

  }


Example Response

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

  {
  "skip": 0,
  "limit": 10,
  "total": 1,
  "data":[{
  "id": "a26b25122362470daca91ae8ad038a27",
  "deviceName": null,
  "mac": "805ec091cfc6",
  "modelName": "UNKNOW",
  "firmwareVersion": "108.86.0.57",
                                                                              121 / 164
Open API for Yealink Management Cloud Service V4X


  "username": "8195",
  "displayName": "8195",
  "siteName": "global测试-baiyf",
  "quality": "Good",
  "startTime": 1660542991000,
  "endTime": 1660543218000,
  "callerURI": "\"8195\" <sip:8195@ume.yealink.com:5061>",
  "calleeURI": "<sip:77031@ume.yealink.com>",
  "duration": 227000
  }]
  }


6.2 QOE details
Request Method
GET
Request URL
/v2/dm/qoe/{qoeId}
Path parameter

 Parameter                 Data Type                Required      Description
 qoeId                     String                   Yes           QOE记录 ID

Response parameters

 Name                    Ty       Description
                         pe
 id                      Str      QOE record ID.
                         ing
 sessionId               Str      The meeting ID.
                         ing
 reportTime              lon      The reporting time of the call data.
                         g
 deviceName              Str      The device name.
                         ing
 mac                     Str      MAC
                         ing


                                                                                122 / 164
Open API for Yealink Management Cloud Service V4X



 modelName               Str      The device model.
                         ing
 firmwareVersio          Str      The firmware version.
 n                       ing
 ip                      Str      The device IP address.
                         ing
 deviceType              Str      The device type: audio, video.
                         ing
 username                Str      Account-username.
                         ing
 displayName             Str      Account-display name.
                         ing
 serverType              Str      The account type.
                         ing
 siteName                Str      The belonging site.
                         ing
 quality                 Str      The call quality, including Good, Poor, and Bad.
                         ing
 startTime               lon      The call start timestamp.
                         g
 endTime                 lon      The call end timestamp.
                         g
 callId                  Str      The call ID.
                         ing
 callerURI               Str      Calling URL, fromURI.
                         ing
 calleeURI               Str      Called URL, toURI.
                         ing
 isCaller                boo      Check whether the user is the caller of the querying
                         lea      call record or not.
                         n
 callType                Str      The call type.
                         ing

                                                                                     123 / 164
Open API for Yealink Management Cloud Service V4X



 confURI                 Str      Configure the URL.
                         ing
 time                    lon      The current time.
                         g
 event                   Str      The events.
                         ing
 duration                lon      The call duration (ms).
                         g
 inJitterAvg             int      Input the average jitter.
 inJitterMax             int      Input the maximum jitter.
 inLossRateAvg           dou      Input the average loss rate.
                         ble
 inLossRateMax           dou      Input the maximum loss rate.
                         ble
 inLossTotal             int      Input the missing value.
 inDelayAvg              int      Input the average delay.
 inDelayMax              int      Input the maximum delay.
 inListenMosAvg          dou      Input the average value for the call answering
                         ble      quality.
 inListenMosMin          dou      Input the minimum value for the call answering
                         ble      quality.
 inConversation          dou      Input the average value for the call quality rating.
 alMosAvg                ble
 inConversation          dou      Input the minimum value for the call quality rating.
 alMosMin                ble
 inReceivePacke          int      The total number of input packages.
 tTotal
 inPayloadNam            Str      Input the load name.
 e                       ing
 outJitterAvg            int      Output the average jitter.
 outJitterMax            int      Output the maximum jitter.
 outLossRateAv           dou      Output the average loss rate.
 g                       ble
                                                                                    124 / 164
Open API for Yealink Management Cloud Service V4X



 outLossRateMa           dou      Output the maximum loss rate.
 x                       ble
 outLossTotal            int      Output the maximum loss.
 outDelayAvg             int      Output the average delay.
 outDelayMax             int      Output maximum delay.
 outListenMosA           dou      Output the average value for the call answering
 vg                      ble      quality.
 outListenMosM           dou      Output the minimum value for the call answering
 in                      ble      quality.
 outConversati           dou      Output the average value for the call quality.
 onalMosAvg              ble
 outConversati           dou      Output the minimum value for the call quality.
 onalMosMin              ble
 outReceivePack          int      The total number of output packages.
 etTotal
 outPayloadNa            Str      Output the load name.
 me                      ing




Example Request

  httpGET /v2/dm/qoe/c5a56e74bab546c8bc3cccf2e82aeb0c HTTP/1.1
  Host: api.ymcs.yealink.com



Example Response

  httpHTTP/1.1 200
  Content-Type: application/json;charset=UTF-8
  {
  "id": "a26b25122362470daca91ae8ad038a27",
  "sessionId": "805ec091cfc6-0_934910374@10.50.144.6",
  "reportTime": 1660543237204,
  "deviceName": null,
  "mac": "805ec091cfc6",
  "modelName": "UNKNOW",

                                                                                    125 / 164
Open API for Yealink Management Cloud Service V4X


  "firmwareVersion": "108.86.0.57",
  "ip": "10.50.144.6",
  "deviceType": "UNKNOW",
  "username": "8195",
  "displayName": "8195",
  "serverType": "SIP",
  "siteName": "global测试-baiyf",
  "quality": "Good",
  "startTime": 1660542991000,
  "endTime": 1660543218000,
  "callId": "0_934910374@10.50.144.6",
  "callerURI": "\"8195\" <sip:8195@ume.yealink.com:5061>",
  "calleeURI": "<sip:77031@ume.yealink.com>",
  "remoteIP": null,
  "callType": "p2p",
  "confURI": null,
  "time": 1660543218000,
  "event": "0",
  "duration": 227000,
  "inJitterAvg": 3,
  "inJitterMax": 3,
  "inLossRateAvg": 0.0,
  "inLossRateMax": 0.0,
  "inDelayAvg": 5,
  "inDelayMax": 5,
  "inListenMosAvg": 4.0,
  "inListenMosMin": 4.0,
  "inConversationalMosAvg": 4.0,
  "inConversationalMosMin": 4.0,
  "inReceivePacketTotal": 11299,
  "inPayloadName": "G722",
  "outJitterAvg": 3,
  "outJitterMax": 4,
  "outLossRateAvg": 0.0,
  "outLossRateMax": 0.0,
  "outLossTotal": 0,
  "outDelayAvg": 5,
  "outDelayMax": 5,
  "outListenMosAvg": 4.4,
  "outListenMosMin": 4.0,
  "outConversationalMosAvg": 4.4,
  "outConversationalMosMin": 4.4,
  "outReceivePacketTotal": 11333,

                                                             126 / 164
Open API for Yealink Management Cloud Service V4X


  "outPayloadName": "G722",

  }


7.Statistics
7.1 Total number of devices
Request Method
GET
Request URL
/v2/dm/statistics/deviceCount
Query parameter

 Para       Dat     Re      Parameter Description
 met        a       qu
 erN        Ty      ir
 ame        pe      ed
 devic      Int     fal     Device status, 1: online, 0: offline, -1: not reported, if this
 eStat      ege     se      parameter is not passed, get the total count.
 us         r
 devi       Int     fal     Device Type
 ceTy       ege     se
 pe         r

Response parameters

 Name                     Type               Description
 total                    Long               Device quantity.

Example Request

  httpGET /v2/dm/statistics/deviceCount?deviceStatus=1 HTTP/1.1
  Host: api.ymcs.yealink.com



Example Response


                                                                                       127 / 164
Open API for Yealink Management Cloud Service V4X


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

  {
  "total":100
  }


7.2 QOE statistics
Request Method
POST
Request URL
/v2/dm/statistics/qoe
Body parameter

 Para       Dat     Re     Parameter Description
 met        a       qu
 erN        Ty      ir
 ame        pe      ed
 siteId     Str     fal    List of site IDs to be counted
 s          ing     se
            []
 start      Lo      fal    The start time to be counted; this value must be used
 Time       ng      se     together with endTime, otherwise it will not take effect.
 endT       Lo      fal    The end time to be counted must be used together with
 ime        ng      se     startTime; otherwise, it will not take effect.

Response parameters

 Name                              Type        Description
 total                             long        The total number of calls.
 badPercentage                     doubl       The percentage of poor quality.
                                   e
 badTotal                          long        Poor call quality.
 goodPercentage                    doubl       The percentage of good quality.
                                   e
 goodTotal                         long        Good call quality.
                                                                                 128 / 164
Open API for Yealink Management Cloud Service V4X



 meetingPercentage                 doubl       The percentage of total meetings.
                                   e
 meetingTotal                      long        The total number of meetings.
 p2pPercentage                     doubl       The percentage of p2p calls.
                                   e
 p2pTotal                          long        The total number of p2p calls.
 poorPercentage                    doubl       The percentage of average quality.
                                   e
 poorTotal                         long        General call quality.
 voiceMailPercentage               doubl       The total number of voice mails.
                                   e
 voiceMailTotal                    long        The total number of voice mails.

Example Request

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

  {
  "startTime":1700876148000,
  "endTime":1703468148329,
  "siteIds":["126b25122362470daca91ae8ad038a27"]
  }


Example Response

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

  {

  "total":25,
  "goodTotal": 24,
  "poorTotal": 1,
  "badTotal": 0,
  "goodPercentage": 0.96,
  "poorPercentage": 0.04,
  "badPercentage": 0.0,
                                                                                    129 / 164
Open API for Yealink Management Cloud Service V4X


  "p2pTotal": 25,
  "meetingTotal": 0,
  "voiceMailTotal": 0,
  "p2pPercentage": 1.0,
  "meetingPercentage": 0.0,
  "voiceMailPercentage": 0.0
  }


8.Model Management
8.1 Model List
Request Method
GET
Request URL
/v2/dm/models
Query parameter

 Paramet         Data          Requi        Description
 er              Type          red
 deviceTy        Integer       Yes          Device Type 1: Phone Device 3: Room
 pe                                         Device

Response parameters

 Parameter            Data Type            Description
 data                 Model[]              The model information array.

Model object definition

 Parameter                    Data Type               Description
 id                           String                  The model ID.
 name                         String                  The model name.

Example Request

  httpGET /v2/dm/models?deviceType=1 HTTP/1.1
  Host: api.ymcs.yealink.com



                                                                                  130 / 164
Open API for Yealink Management Cloud Service V4X



Example Response

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

  [{
  "id": "61e659e4d78d42ebada88ef1eb751b64",
  "name":"SIP-T54S",

  },{
  "id":"02c47b640c3046dc86853c9ccfd37dd0",
  "name":"SIP-T31P"
  }]




9.Site Management
9.1 Add Site
Request Method
POST
Request URL
/v2/dm/sites
Body parameter

 Parameter           Data            Require        Description
                     Type            d
 name                String          Yes            Site name, maximum length 128
 parentId            String          Yes            Parent Site ID
 Description         String          No             Description, maximum length 1024

HTTP status code

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

                                                                                    131 / 164
Open API for Yealink Management Cloud Service V4X



Response parameters

 parameter                       Data Type          Description
 id                              String             Site ID
 name                            String             Site Name
 parentId                        String             Parent Site ID
 siteNumber                      String             Site number

Example Request

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

  {
  "name":"site1",
  "parentId":"d3a6ff43f2154b868ba1157eb3677c1e",
  "Description":"site1"

  }


Example Response

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

  {
  "id": "0006d62003684754b11c09c5d94ea687",
  "name":"site1",
  "parentId":"d3a6ff43f2154b868ba1157eb3677c1e",
  "siteNumber":"ofpb5gvg"
  }


9.2 Edit Site
Request Method
PATCH
Request URL
/v2/dm/sites/{siteId}

                                                                     132 / 164
Open API for Yealink Management Cloud Service V4X



Path parameter

 parameter                 Data Type                Required         Description
 siteId                    String                   Yes              Site ID

Body parameter

 Parameter           Data            Require        Description
                     Type            d
 name                String          No             Site Name
 parentId            String          No             Parent Site ID
 Description         String          No             Description，maximum length 1024.

HTTP status code

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

Example Request

  httpPATCH /v2/dm/sites/0006d62003684754b11c09c5d94ea687 HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "name":"site11",
  "Description":"site11",
  "parentId":"d3a6ff43f2154b868ba1157eb3677c1e"
  }


Example Response

  httpHTTP/1.1 204


9.3 Delete Site

                                                                                   133 / 164
Open API for Yealink Management Cloud Service V4X



Request Method
DELETE
Request URL
/v2/dm/sites/{siteId}
PATH parameter

 parameter                 Data Type                Required     Description
 siteId                    String                   Yes          Site ID

Example Request

  httpDELETE /v2/dm/sites/e33b8f25247e45de84dd4c74503b241a HTTP/1.1
  Host: api.ymcs.yealink.com


Example Response

  httpHTTP/1.1 204


9.4 Site List
Request Method
POST
Request URL
/v2/dm/listSites
Body parameter

 Parame         Data      Req       Parameter Description
 terNam         Type      uire
 e                        d
 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.
 autoCou        Bool      No        Whether to return the total number of records
 nt             ean
 filter         Filter    No        search parameters

                                                                                    134 / 164
Open API for Yealink Management Cloud Service V4X



Filter object definition

 Parameter                 Data Type                  Required         Description
 name                      String                     No               Site Name

Response parameters

 Parameter                Data Type                 Description
 data                     Site[]                    Site information array

Site object definition

 Paramet         Data              Description
 er              Type
 id              String            site id
 parentId        String            Parent Site ID
 name            String            Site Name
 level           Integer           Site level, 0 indicates the root site.
 sequence        Integer           “Serial number of the site in the hierarchy”

Example Request

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

  {
  "skip":0,
  "limit":10,
  "filter":{
  "name":"test"
  }

  }




Example Response


                                                                                     135 / 164
Open API for Yealink Management Cloud Service V4X


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

  {
  "skip": 0,
  "limit": 10,
  "total": 1,
  "data":[{
  "id":"1e876bc0fca24b728eeb3e52bbfebf5e",
  "parentId":"23b63cac1f6d4134b5459a4face901c3",
  "name":"test",
  "level":2,
  "sequence":1,

  }]
  }


9.5 site details
Request Method
GET
Request URL
/v2/dm/sites/{siteId}
Path parameter

 parameter                 Data Type                 Required        Description
 siteId                    String                    Yes             Site ID

Response parameters

 parameter                  Data Type               Description
 id                         String                  Site ID
 parentId                   String                  Parent Site ID
 name                       String                  Site Name
 siteNumber                 String                  Site number
 Description                String                  Description information

Example Request


                                                                                   136 / 164
Open API for Yealink Management Cloud Service V4X


  httpGET /v2/dm/sites/288ff0d0bd4948b0a95785ba7bc72a8e HTTP/1.1
  Host: api.ymcs.yealink.com


HTTP status code

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

Example Response

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

  {
  "id": "288ff0d0bd4948b0a95785ba7bc72a8e",
  "name":"site1",
  "parentId":"d3a6ff43f2154b868ba1157eb3677c1e",
  "siteNumber":"ofpb5gvg",
  "Description":"site1"
  }


10.Resource Management
10.1 Firmware Management
10.1.1 Firmware List
Request Method
POST
Request URL
/v2/dm/listFirmwares
Body parameter

 Pa Da         Re     Description
 ra ta         qu
 me Ty         ir

                                                                   137 / 164
Open API for Yealink Management Cloud Service V4X



 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

 Paramete          Data          Requi       Description
 r                 Type          red
 modelId           String        No          Firmware Model ID
 firmwareT         Integer       No          Firmware Type 0: Master Device 1:
 ype                                         Accessory
 deviceTyp         Integer       No          Device Type 1: Phone Device 3: Room
 e                                           Device

HTTP status code

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

Response parameters

 Parameter            Data Type              Description
                                                                                   138 / 164
Open API for Yealink Management Cloud Service V4X



 skip                 Long                   offset
 limit                Long                   The maximum returned number.
 total                Long                   Total quantity
 data                 Firmware[]             Firmware information array

Firmware object definition

 Parameter            Data           Description
                      Type
 id                   String         firmware id
 name                 String         Firmware Name
 deviceType           Integer        Device Type 1: Phone Device 3: Room Device
 firmwareTyp          Integer        Firmware Type 0: Master Device 1: Accessory
 e
 version              String         Firmware version number

Example Request

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

  {
  "skip": 0,
  "limit": 10,
  "autoCount": true,
  "filter":{
  "firmwareType":0,
  "deviceType":1
  }
  }


Example Response

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

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


  "limit": 10,
  "total": 1,
  "data":[{
  "id": "01d7ae1897f7418dad2d26609329be38",
  "name":"t54s firmware",
  "deviceType":1,
  "firmwareType":0,
  "version":"108.85.3.19",
  }]
  }


10.1.2 Firmware Details
Request Method
GET
Request URL
/v2/dm/firmwares/{firmwareId}
Path parameter

 parameter                  Data Type               Required    Description
 firmwareId                 String                  Yes         firmware 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           Description
                       Type
 id                    String         firmware id
 name                  String         Firmware Name
 filename              String         Firmware file name
 deviceType            Integer        Device Type 1: Phone Device 3: Room Device
                                                                                   140 / 164
