# Open API for Yealink Management Cloud Service V4X.pdf - Pages 101-120

**Source:** Open API for Yealink Management Cloud Service V4X.pdf
**Pages:** 101-120 of 164
**Chunk:** 6

---

Open API for Yealink Management Cloud Service V4X



 sn                      String                 The device SN address.
 errorInfo               String                 Error message.

Example Request

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

  [{
  "mac":"3a1565bbb1a9",
  "sn":"1106312113402006",
  "serverId":"ba7c7b13ed114a5fa6f12063ea9dff41",
  "remark":"SeakeerDevice",
  "authName":"Seakeer",
  "password":"654321"

  }]


Example Response

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

  {
  "total": 1,
  "successCount":0,
  "failureCount":1,
  "errors":[{
  "mac":"3a1565bbb1a9",
  "sn":"1106312113402006",
  "errorInfo":"Invalid MAC"
  }]
  }


5.1.3 Add device without SN
Note: A maximum of 100 items at a time.
Request Method
POST


                                                                         101 / 164
Open API for Yealink Management Cloud Service V4X



Request URL
/v2/rps/addDevicesByMac
Body parameter

 Parameter           Data         Requ       Description
                     Type         ired
 mac                 String       Yes        Device MAC, minimum length 12, maximum
                                             length 17
 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
 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

                                                                                    102 / 164
Open API for Yealink Management Cloud Service V4X



 parameter               Data Type              Description
 mac                     String                 The device MAC address.
 sn                      String                 The device SN address.
 errorInfo               String                 Error message.

Example Request

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

  [{
  "mac":"3a1565bbb1a9",
  "serverId":"ba7c7b13ed114a5fa6f12063ea9dff41",
  "remark":"SeakeerDevice",
  "authName":"Seakeer",
  "password":"654321"

  }]


Example Response

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

  {
  "total": 1,
  "successCount":0,
  "failureCount":1,
  "errors":[{
  "mac":"3a1565bbb1a9",
  "sn":"1106312113402006",
  "errorInfo":"Invalid MAC"
  }]
  }


5.1.4 Edit Device
Request Method
PATCH

                                                                          103 / 164
Open API for Yealink Management Cloud Service V4X



Request URL
/v2/rps/devices/{deviceId}
Path parameter

 parameter               Data Type              Required       Description
 deviceId                String                 Yes            The device ID.

Body parameter

 Parameter           Data         Requi       Description
                     Type         red
 serverId            String       No          Server ID
 uniqueServe         String       No          Address of server, maximum length 256
 rUrl
 authName            String       No          Username for authentication, maximum
                                              length 128
 password            String       No          Password for authentication, maximum
                                              length 128
 remark              String       No          Note, maximum length 256

HTTP status code

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

Example Request

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

  {
  "serverId":"ba7c7b13ed114a5fa6f12063ea9dff41",
  "remark":"SeakeerDevice",

                                                                                  104 / 164
Open API for Yealink Management Cloud Service V4X


  "authName":"Seakeer",
  "password":"654321"

  }


Example Response

  httpHTTP/1.1 204


5.1.5 Device Paging List
Request Method
POST
Request URL
/v2/rps/listDevices
Body parameter

 Paramet        Dat      Re      Description
 er             a        qu
                Ty       ire
                pe       d
 skip           Lon      No      Number of skipped records, default is 0
                g
 limit          Lon      No      Maximum number of records to retrieve, default is
                g                10, 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
                n                first page, and set it to false for queries on other
                                 pages.
 filter         Filt     No      search parameters
                er

Filter object definition

 Para      Data        Req     Description
 met       Typ         uir
 er        e           ed

                                                                                    105 / 164
Open API for Yealink Management Cloud Service V4X



 mac       Strin     No       Device MAC, maximum length 17, supports with : or -,
           g                  such as 00:15:65:bb:b1:a1

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                 Device[]             Device information array

Device object definition

 parameter           Data        Description
                     Type
 id                  String      The device ID.
 mac                 String      The device MAC address.
 sn                  String      The device serial number.
 serverId            String      The server ID.
 serverName          String      The server name.
 serverUrl           String      The server address.
 uniqueServe String              The address of the unique server.
 rUrl
 ipAddress           String      The IP address.
 remark              String      The remark.
 dateRegiste         Long        The binding time.
 red
                                                                               106 / 164
Open API for Yealink Management Cloud Service V4X



 lastConnect         Long        The last time when the device is connected to the
 ed                              platform.

Example Request

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

  {
  "skip": 0,
  "limit": 20,
  "autoCount": true,
  "filter":{
  "mac":"001565bbb1a9"
  }
  }


Example Response

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

  {
  "skip": 0,
  "limit": 10,
  "total": 1,
  "data":[{
  "id": "8d07a56207074d26b61026099625b9e2",
  "mac":"001565bbb1a9",
  "sn":"1106312113402006",
  "serverId": "b25ac1016caf416a90d5ca1ee438153a",
  "serverName": "SeakeerServerTest",
  "serverUrl": "https://dm30-devtest.yealinkclient.com/dm.cfg",
  "ipAddress": null,
  "dateRegistered": 1542680124026,
  "lastConnected": null,
  "remark": "edit"

  }]
  }


                                                                                107 / 164
Open API for Yealink Management Cloud Service V4X


5.1.6 Device Details
Request Method
GET
Request URL
/v2/rps/devices/{deviceId}
PATH parameter

 parameter               Data Type              Required      Description
 deviceId                String                 Yes           The device ID.

Response parameters

 parameter           Data         Description
                     Type
 id                  String       The device ID.
 mac                 String       The device MAC address.
 sn                  String       The device serial number.
 serverId            String       The server ID.
 serverName          String       The server name.
 serverUrl           String       The server address.
 uniqueServe String               The address of the unique server.
 rUrl
 ipAddress           String       The IP address.
 remark              String       The remark.
 dateRegiste         Long         The binding time.
 red
 lastConnect         Long         The last time when the device is connected to the
 ed                               platform.
 authName            String       The username for authentication.

Example Request

  httpGET /v2/rps/devices/8d07a56207074d26b61026099625b9e2 HTTP/1.1
  Host: api.ymcs.yealink.com


                                                                                 108 / 164
Open API for Yealink Management Cloud Service V4X




Example Response

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

  {
  "id": "8d07a56207074d26b61026099625b9e2",
  "mac":"001565bbb1a9",
  "sn":"1106312113402006",
  "serverId": "b25ac1016caf416a90d5ca1ee438153a",
  "serverName": "SeakeerServerTest",
  "serverUrl": "https://dm30-devtest.yealinkclient.com/dm.cfg",
  "ipAddress": null,
  "dateRegistered": 1542680124026,
  "lastConnected": null,
  "remark": "edit",
  "authName": "edit",
  }


5.1.7 Delete Device
Request Method
POST
Request URL
/v2/rps/delDevices
Body parameter

 Paramet         Data             Require       Description
 er              Type             d
 deviceIds       String           Yes           Device ID list, maximum length 200

HTTP status code

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

                                                                                     109 / 164
Open API for Yealink Management Cloud Service V4X



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/rps/delDevices HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "deviceIdType":"mac",
  "deviceIds":["001565bbb1a9","001567"]
  }


Example Response

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

  {
  "total": 2,
  "successCount":1,
  "failureCount":1,
  "errors":[{
  "field":"001567",
  "msg":"Invalid MAC"
  }]
  }
                                                                                 110 / 164
Open API for Yealink Management Cloud Service V4X




5.2 RPS server management
5.2.1 Add Server
Request Method
POST
Request URL
/v2/rps/servers
Body parameters:

 Request                      Parame Re             Description
 parameters                   ter    qui
                              Type   re
                                     d
 serverName                   String       Yes      The server name, with no more than 20
                                                    characters.
 url                          String       Yes      The address of server, with no more
                                                    than 512 characters.
 authName                     String       No       The username for authentication, with
                                                    no more than 32 characters.
 password                     String       No       The password for authentication, with
                                                    no more than 32 characters.
 certificateUrl               String       No       The certificate URL.
 serverCertificateUr          String       No       The URL of the server certificate.
 l
 serverCertificateE           Boolea       No       Set whether to enable the custom
 nable                        n                     certificate or not.
 serverCertificate            Boolea       No       Enable this when the certificate type is
 EnableWithSHA25              n                     non-SHA256.
 6

HTTP status code

 Code         Description
 201          Operation successful, see response parameters.

                                                                                         111 / 164
Open API for Yealink Management Cloud Service V4X



 400          Client parameter exception
 401          Authentication failed
 500          Server exception

Response parameters

 parameter            Data Type          Description
 id                   String             The server ID.
 serverName           String             The server name.
 url                  String             The server address.
 authName             String             The username for authentication.

Example Request

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

  {
  "serverName":"TestServer",
  "url":"https://https://www.yealink.com",
  "serverCertificateEnable": true,
  "serverCertificateEnableWithSHA256": true,
  "authName":"Seakeer",
  "password":"123456",
  "certificateUrl":"https://www.yealink.com/certificate"

  }


Example Response

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

  {
  "id": "b38dea23a4e6458188799833b72d950f",
  "serverName": "TestServer",
  "url": "https://www.yealink.com",
  "authName": "Seakeer"
  }
                                                                            112 / 164
Open API for Yealink Management Cloud Service V4X




5.2.2 Edit Server
Request Method
PATCH
Request URL
/v2/rps/servers/{serverId}
PATH parameter

 parameter               Data Type               Required         Description
 serverId                String                  Yes              The server ID.

Body parameters:

 Request                      Parame Re             Description
 parameters                   ter    qui
                              Type   re
                                     d
 serverName                   String       Yes      The server name, with no more than 20
                                                    characters.
 url                          String       Yes      The address of server, with no more
                                                    than 512 characters.
 authName                     String       No       The username for authentication, with
                                                    no more than 32 characters.
 password                     String       No       The password for authentication, with
                                                    no more than 32 characters.
 certificateUrl               String       No       The certificate URL.
 serverCertificateUr          String       No       The URL of the server certificate.
 l
 serverCertificateE           Boolea       No       Set whether to enable the custom
 nable                        n                     certificate or not.
 serverCertificate            Boolea       No       Enable this when the certificate type is
 EnableWithSHA25              n                     non-SHA256.
 6

HTTP status code

                                                                                         113 / 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

  httpPATCH /v2/rps/servers/b38dea23a4e6458188799833b72d950f HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "serverName":"YealinkServer",
  "url":"http://www.yealink.com",
  "authName":"Yealink",
  "password":"Yealink",
  "certificateUrl":"http://cer/cer.cer",
  "serverCertificateEnable": true,
  "serverCertificateEnableWithSHA256": true

  }


Example Response

  httpHTTP/1.1 204


5.2.3 Delete Server
Request Method
POST
Request URL
/v2/rps/delServers
Body parameter

 Paramet         Data             Require       Description
 er              Type             d
 serverIds       String[]         Yes           Server ID list, maximum length 200

                                                                                     114 / 164
Open API for Yealink Management Cloud Service V4X



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/rps/delServers HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "serverIds":["b38dea23a4e6458188799833b72d950f","1234"]
  }


Example Response

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

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


                                                                                 115 / 164
Open API for Yealink Management Cloud Service V4X


5.2.4 Server Details
Request Method
GET
Request URL
/v2/rps/servers/{serverId}
Path parameter

 parameter               Data Type              Required             Description
 serverId                String                 Yes                  The server ID.

Response parameters

 parameter                            Data          Description
                                      Type
 id                                   Strin         The server ID.
                                      g
 serverName                           Strin         The server name.
                                      g
 url                                  Strin         The server address.
                                      g
 authName                             Strin         The username for authentication.
                                      g
 certificateUrl                       Strin         The certificate URL.
                                      g
 serverCertificateUrl                 Strin         The URL of the server certificate.
                                      g
 serverCertificateEnable              Bool          Set whether to enable the custom
                                      ean           certificate or not.
 serverCertificateEnable              Bool          Enable this when the certificate type is
 WithSHA256                           ean           non-SHA256.

Example Request

  httpGET /v2/rps/servers/b38dea23a4e6458188799833b72d950f HTTP/1.1
  Host: api.ymcs.yealink.com

                                                                                         116 / 164
Open API for Yealink Management Cloud Service V4X




Example Response

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

  {
  "id": "b38dea23a4e6458188799833b72d950f",
  "serverName": "TestServer",
  "url": "https://www.yealink.com",
  "authName": "Seakeer",
  "certificateUrl":"http://cer/cer.cer",
  "serverCertificateEnable": true,
  "serverCertificateEnableWithSHA256": true
  }


5.2.5 Server Pagination List
Request Method
POST
Request URL
/v2/rps/listServers
Body parameter

 Para       Data       Requ Description
 mete       Type       ired
 r
 searc      Strin      No        Search keywords, support server name, URL search
 hKey       g
 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        search parameters

Filter object definition

                                                                                 117 / 164
Open API for Yealink Management Cloud Service V4X



 Parameter              Data Type             Required      Description
 name                   String                No            The server name.

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 data volume
 data                 Server[]             Server information array

Server object definition

 parameter            Data Type          Description
 id                   String             The server ID.
 serverName           String             The server name.
 url                  String             The server address.
 authName             String             The username for authentication.

Example Request

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

  {
  "skip": 0,
  "limit": 20,
  "autoCount": true,
  "filter":{
                                                                               118 / 164
Open API for Yealink Management Cloud Service V4X


  "name":"test"
  }
  }


Example Response

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

  {
  "skip": 0,
  "limit": 10,
  "total": 1,
  "data":[{
  "id": "b38dea23a4e6458188799833b72d950f",
  "serverName": "test",
  "url": "https://www.yealink.com",
  "authName": "Seakeer"
  }]
  }


6.Call Quality Management
6.1 Pagination List
Request Method
POST
Request URL
/v2/dm/listQoes
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
                                                                                    119 / 164
Open API for Yealink Management Cloud Service V4X



 filter         Filter      No       search parameters

Filter object definition

 Para      Data      Req         Description
 met       Typ       uir
 er        e         ed
 mac       Strin     No          Device MAC, maximum length 17, supports with : or -,
           g                     such as 00:15:65:bb:b1:a9
 siteI     List      fals        List of site IDs to query
 ds                  e
 star      Long      fals        Start time to query
 tTim                e
 e
 endT      Long      fals        End time to query
 ime                 e

Response parameters

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

QoeInfo object definition

 Name                              Type        Description
 id                                String      QOE record id
 deviceName                        String      Device Name
 mac                               String      MAC
 modelName                         String      Device Model
 firmwareVersion                   String      Firmware version
 username                          String      Account \u2014 Username
 displayName                       String      Account \u2014 Display Name

                                                                                  120 / 164
