# Open API for Yealink Management Cloud Service V4X.pdf - Pages 41-60

**Source:** Open API for Yealink Management Cloud Service V4X.pdf
**Pages:** 41-60 of 164
**Chunk:** 3

---

Open API for Yealink Management Cloud Service V4X


  httpPOST /v2/dm/device/reboot 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":"0006572538f74e8683716cf961caa95b",
  "msg":"The resource does not exist or has been deleted"
  }]
  }


2.3.2 Device Factory Reset
Request Method
POST
Request URL
/v2/dm/device/reset
Body parameter

 Paramet         Data          Requi        Description
 er              Type          red
 deviceIds       String[]      Yes          Device ID list
 deviceTy        Integer       Yes          Device Type 1: Phone Device 3: Room
 pe                                         Device

                                                                                  41 / 164
Open API for Yealink Management Cloud Service V4X



HTTP status code

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

Response parameters

 Parameter             Data            Description
                       Type
 total                 Integer         Total number of factory restored devices
 successCoun           Integer         Number of successful factory restored
 t
 failureCount          Integer         Number of failed factory restored
 errors                OpError[]       Error message.

OpError object

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

Example Request

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

  {
  "deviceIds":
  ["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"],
  "deviceType":1

  }


Example Response

                                                                                  42 / 164
Open API for Yealink Management Cloud Service V4X


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

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


2.4 Device Identification Management
2.4.1 Obtain Device ID
Request Method
POST
Request URL
/v2/dm/deviceId
Body parameter

 Param        Data       Req      Description
 eter         Type       uir
                         ed
 device       Integ      Yes      Device Type 1: Phone Device 3: Room Device
 Type         er
 device       Strin      No       Indicates the type of device identifier, default is
 IdType       g                   mac, optional is mac.
 deviceI      Strin      Yes      Device ID, limit 200 characters
 ds           g[]

HTTP status code

 Code                Description
 200                 Operation successful
 400                 Client parameter exception
 401                 Authentication failed
                                                                                        43 / 164
Open API for Yealink Management Cloud Service V4X



 500                 Server exception

Response parameters

 parameter                Data Type                 Description
 key                      String                    Device identification
 deviceId                 String                    The device ID.

Example Request

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

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


Example Response

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

  [{
  "key":"001565bbb1a9",
  "deviceId":"8d07a56207074d26b61026099625b9e2"
  }]


2.5 Device Accessories Management
2.5.1 Accessory List
Request Method
POST
Request URL
/v2/dm/devices/{deviceId}/listParts
Path parameter


                                                                            44 / 164
Open API for Yealink Management Cloud Service V4X



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

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      accessory id
 mac                String      Accessory MAC
 sn                 String      Accessory SN

                                                                                 45 / 164
Open API for Yealink Management Cloud Service V4X



 modelId            String      Model ID
 connectWa          String      Connection methods for accessories, including USB,
 y                              BT, etc.
 connStatus         Intege      Status, 1: online, 0: offline
                    r
 lanIp              String      Intranet IP
 programVer         String      Firmware version number
 sion
 lastReport         Long        Last reporting time
 Time

Example Request

  httpPOST /v2/dm/devices/8d07a56207074d26b61026099625b9e2/listParts HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

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



Example Response

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



  {
  "skip": 0,
  "limit": 10,
  "total": 1,
  "data":[{
  "id": "5d6017f6fe004eb7ac1107c80c1c44b7",
  "mac":"001565bbb1a9",
  "sn":"1106312113402006",
  "modelId":"e7c5c0c406cf4a02bd9ed64183d1de05",

                                                                                46 / 164
Open API for Yealink Management Cloud Service V4X


  "modelName": "CP700",
  "connectWay":"USB",
  "connStatus":1,
  "lanIp":"10.60.50.22",
  "programVersion":"153.433.0.5",
  "lastReportTime":1709577211630
  }]
  }



2.5.2 Accessory Details
Request Method
GET
Request URL
/v2/dm/devices/{deviceId}/parts/{partId}
Path parameter

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

HTTP status code

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

Response parameters

 Par       Da     Description
 ame       ta
 ter       Ty
           p
           e
 id        St     accessory id
                                                                            47 / 164
Open API for Yealink Management Cloud Service V4X



           ri
           ng
 mac       St     Accessory MAC
           ri
           ng
 sn        St     Accessory SN
           ri
           ng
 mod       St     Model ID
 elId      ri
           ng
 con       St     Connection methods for accessories, including USB, BT, etc.
 nec       ri
 tWa       ng
 y
 conn      In     Status, 1: online, 0: offline
 Stat      te
 us        ge
           r
 lanI      St     Intranet IP
 p         ri
           ng
 prog St          Firmware version number
 ramV ri
 ersi ng
 on
 last      Lo     Last reporting time
 Rep       ng
 ortT
 ime
 extr      Ex     Additional information related to the model, when the model is
 aInf      tr     a sensor, the response content includes temperature, battery
 o         aI     level, and other information.
           nf
           o

                                                                                48 / 164
Open API for Yealink Management Cloud Service V4X



ExtraInfo object definition
  When the model is a sensor, the content is as follows.

 parameter                 Data Type                       Description
 batteryLevel              Integer                         Battery Level
 humidity                  Integer                         Humidity
 irradiance                IntegerIlluminance
 temperature               Integer                         Temperature
 numPeople                 Integer                         People Count Statistics

Example Request

  httpGET /v2/dm/devices/8d07a56207074d26b61026099625b9e2/
  parts/104aa43ca9994de0825ec8d32f3a8c60 HTTP/1.1
  Host: api.ymcs.yealink.com


Example Response

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

  {
  "id": "104aa43ca9994de0825ec8d32f3a8c60",
  "mac":"84fd27df8045",
  "sn":"803111D070000358",
  "modelId":"50b2674518a648968367ea2bb61a5572",
  "modelName":"RoomSensor",
  "connectWay":"BT",
  "connStatus":1,
  "lanIp":"10.60.50.21",
  "programVersion":"153.433.0.5",
  "lastReportTime":1709577211630,
  "extraInfo":{
  "batteryLevel":100,
  "humidity":55,
  "irradiance":27,
  "temperature":31,
  "numPeople":2
  }



                                                                                     49 / 164
Open API for Yealink Management Cloud Service V4X


  }


2.5.2 Accessory Restart
Request Method
POST
Request URL
/v2/dm/devices/{deviceId}/parts/reboot
Path parameter

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

Body parameter

 Pa      Dat      Re     Description
 ram     a        qu
 ete     Ty       ir
 r       pe       ed
 par     Stri     No     Accessory ID list, maximum length 200, not passing
 tId     ng[             indicates a restart of all accessories under this device.
 s       ]

HTTP status code

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

Response parameters

 parameter               Data Type          Description
 total                   Integer            Total number of rebooted devices
 successCount            Integer            Number of successful reboots
 failureCount            Integer            Number of failed reboots

                                                                                     50 / 164
Open API for Yealink Management Cloud Service V4X



 errors                  OpError[]          Error message.

OpError object

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

Example Request

  httpPOST /v2/dm/device/0006572538f74e8683716cf961caa95b/parts/reboot HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "partIds":["00ab7c8da8ff4345af3857feb68aedef","0299d1254f7042068c4ef1c5895b7e5a"]
  }


Example Response

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

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


2.5.4 Restore Accessories to Factory Settings
Request Method
POST
Request URL
/v2/dm/devices/{deviceId}/parts/reset
Path parameter
                                                                               51 / 164
Open API for Yealink Management Cloud Service V4X



 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
 pa      St    N      Accessory ID list, maximum length of 200, if not provided,
 rt      ri    o      indicates that all accessories under this device will be
 Id      ng           restored to factory settings.
 s       []

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         Total number of factory restored devices
 successCoun           Integer         Number of successful factory restored
 t
 failureCount          Integer         Number of failed factory restored
 errors                OpError[]       Error message.

OpError object

 Parameter                     Data Type                Description
 field                         String                   Error field

                                                                                   52 / 164
Open API for Yealink Management Cloud Service V4X



 msg                           String                  Error message.

Example Request

  httpPOST /v2/dm/device/0006572538f74e8683716cf961caa95b/parts/reset HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "partIds":["00ab7c8da8ff4345af3857feb68aedef","0299d1254f7042068c4ef1c5895b7e5a"]
  }


Example Response

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

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


2.6 Device Account Management
2.6.1 Device Binding Account
Request Method
POST
Request URL
/v2/dm/devices/{deviceId}/bindAccounts
Path parameter

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

Body parameter
                                                                                 53 / 164
Open API for Yealink Management Cloud Service V4X



 Parame         Data Type           Requi           Description
 ter                                red
 account        BindAccount         Yes             List of account information to be bound
 s              []

BindAccount object definition

 Parameter            Data              Description
                      Type
 lineId               integer           Account line, starting from 1
 accountType          Integer           Account type: 0: SIP, 1: H323, 2: SFB
 accountId            String            Account 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
 total                     Integer            Total number of bindings
 successCount              Integer            Number of successful bindings
 failureCount              Integer            Number of failed bindings
 errors                    OpError[]          Error message.

OpError object

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

Example Request


                                                                                        54 / 164
Open API for Yealink Management Cloud Service V4X


  httpPOST /v2/dm/devices/8d07a56207074d26b61026099625b9e2/bindAccounts
  HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  [{
  "lineId":1,
  "accountType":0,
  "accountId":"604e67944c7c43fe8b66099254ec3439"
  },{
  "lineId":2,
  "accountType":0,
  "accountId":"a45a6b4a7e0447b8a6c3f2839d902acd"
  }]


Example Response

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

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


2.6.2 Device Unbinding Account
Request Method
POST
Request URL
/v2/dm/devices/{deviceId}/unbindAccounts
Path parameter

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

                                                                             55 / 164
Open API for Yealink Management Cloud Service V4X



Body parameter

 Paramete          Data             Require         Description
 r                 Type             d
 accountIds        String[]         Yes             List of account IDs to be unbound

HTTP status code

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

Response parameters

 parameter                Data Type          Description
 total                    Integer            The total number of unbundled
 successCount             Integer            Number of successful unbindings
 failureCount             Integer            Number of failed unbindings
 errors                   OpError[]          Error message.

OpError object

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

Example Request

  httpPOST /v2/dm/devices/8d07a56207074d26b61026099625b9e2/unbindAccounts
  HTTP/1.1
  Host: api.ymcs.yealink.com
  Content-Type: application/json

  {
  "accountIds":
  ["604e67944c7c43fe8b66099254ec3439","a45a6b4a7e0447b8a6c3f2839d902acd"]

                                                                                        56 / 164
Open API for Yealink Management Cloud Service V4X


  }


Example Response

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

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


2.6.3 List of accounts bound to the device
Request Method
GET
Request URL
/v2/dm/devices/{deviceId}/boundAccounts
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

Response parameters

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



 data               BindAccount[]              Bind account information array

BindAccount object definition

 Parameter               Data             Description
                         Type
 accountId               String           Account ID
 lineId                  Integer          Account line, starting from 1
 accountType             Integer          Account type: 0: SIP, 1: H323, 2: SFB
 accountServer           String           Account server address
 registerName            String           Registration Name
 username                String           User Name

Example Request

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



Example Response

  httpHTTP/1.1 200
  Content-Type: application/json

  [{
  "accountId":"604e67944c7c43fe8b66099254ec3439"
  "lineId":1,
  "accountType":0,
  "accountServer":"10.200.108.48",
  "registerName":"1000",
  "username":"1000"



  },{
  "accountId":"a45a6b4a7e0447b8a6c3f2839d902acd"
  "lineId":2,
  "accountType":0,
  "accountServer":"10.200.108.48",
  "registerName":"2000",
                                                                                  58 / 164
Open API for Yealink Management Cloud Service V4X


  "username":"2000"

  }]


3.Account Management
3.1 Add SIP account
Request Method
POST
Request URL
/v2/dm/sipAccounts
Body parameter

 Paramet         Data        Requ       Description
 er              Type        ired
 register        String      Yes        The registered name, with no more than 128
 Name                                   characters.
 usernam         String      Yes        Username, maximum length 128
 e
 passwor         String      Yes        Password, maximum length 128
 d
 display         String      No         Display name, maximum length 128
 Name
 label           String      No         Label, maximum length 128
 sipServe        SipSer      Yes        sip server 1 address
 r1              ver
 sipServe        SipSer      No         sip server 2 address
 r2              ver
 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

                                                                                 59 / 164
Open API for Yealink Management Cloud Service V4X



 port               Integer            Server port, 0~65535

HTTP status code

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

Response parameters

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

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

                                                                                  60 / 164
