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
This commit is contained in:
116
.claude/skills/yealink-ymcs/docs/SIPSERVER_SCHEMA.md
Normal file
116
.claude/skills/yealink-ymcs/docs/SIPSERVER_SCHEMA.md
Normal file
@@ -0,0 +1,116 @@
|
||||
# YMCS SIP Account Schema - Critical Field Formats
|
||||
|
||||
**Source:** Open API for Yealink Management Cloud Service V4X, pages 59-60 (chunk-03)
|
||||
|
||||
## Add SIP Account Endpoint
|
||||
|
||||
```
|
||||
POST /v2/dm/sipAccounts
|
||||
```
|
||||
|
||||
## Complete Request Body Schema
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| registerName | String | Yes | Registered name, max 128 chars |
|
||||
| username | String | Yes | Username, max 128 chars |
|
||||
| password | String | Yes | Password, max 128 chars |
|
||||
| displayName | String | No | Display name, max 128 chars |
|
||||
| label | String | No | Label, max 128 chars |
|
||||
| **sipServer1** | **SipServer** | **Yes** | **SIP server 1 address (OBJECT, not string)** |
|
||||
| sipServer2 | SipServer | No | SIP server 2 address (object) |
|
||||
| remark | String | No | Note, max 512 chars |
|
||||
| siteId | String | No | Site ID to assign |
|
||||
|
||||
## SipServer Object Definition
|
||||
|
||||
**CRITICAL:** sipServer1/sipServer2 are **objects**, not strings.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| host | String | Server address, max 256 chars |
|
||||
| port | Integer | Server port, 0-65535 |
|
||||
|
||||
## Working Example (from official docs)
|
||||
|
||||
```json
|
||||
POST /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
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## PacketDial Integration Example
|
||||
|
||||
For provisioning to PacketDial/NetSapiens PBX:
|
||||
|
||||
```json
|
||||
{
|
||||
"registerName": "100@vwp.91912.service",
|
||||
"username": "100@vwp.91912.service",
|
||||
"password": "TestPass123",
|
||||
"label": "Extension 100",
|
||||
"displayName": "Test User",
|
||||
"sipServer1": {
|
||||
"host": "pbx.packetdial.com",
|
||||
"port": 5060
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## HTTP 412 Error Resolution
|
||||
|
||||
**Error:** `HTTP 412: {"code": "900444", "details": [{"field": "sipServer1", "message": "Parameter error, please refer to documentation related to interface parameters"}]}`
|
||||
|
||||
**Cause:** Passing sipServer1 as a string instead of an object
|
||||
|
||||
**Fix:** Use the SipServer object format with both `host` and `port` fields
|
||||
|
||||
## Response (201 Created)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "604e67944c7c43fe8b66099254ec3439",
|
||||
"username": "2552",
|
||||
"registerInfo": "2552",
|
||||
"serverAddress": "ume.yealink.com:5061",
|
||||
"accountType": 0,
|
||||
"remark": "",
|
||||
"createTime": 1234567890000
|
||||
}
|
||||
```
|
||||
|
||||
Response fields:
|
||||
- `id`: Account ID (use for binding to devices)
|
||||
- `accountType`: 0=SIP, 1=H323, 2=SFB
|
||||
- `serverAddress`: Combined host:port from sipServer1
|
||||
- `createTime`: Unix timestamp in milliseconds
|
||||
|
||||
## Next Step: Bind Account to Device
|
||||
|
||||
After creating the SIP account, bind it to a phone:
|
||||
|
||||
```
|
||||
POST /v2/dm/devices/{deviceId}/bindAccounts
|
||||
```
|
||||
|
||||
Body:
|
||||
```json
|
||||
{
|
||||
"accountIds": ["604e67944c7c43fe8b66099254ec3439"],
|
||||
"lineId": 1
|
||||
}
|
||||
```
|
||||
|
||||
See chunk-03 pages 52-56 for bindAccounts endpoint details.
|
||||
104
.claude/skills/yealink-ymcs/docs/chunks/README.md
Normal file
104
.claude/skills/yealink-ymcs/docs/chunks/README.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# YMCS Documentation Chunks
|
||||
|
||||
Large PDF documentation broken into bite-sized markdown files for easier processing.
|
||||
|
||||
## Generated From
|
||||
|
||||
4 YMCS PDFs downloaded 2026-07-09, totaling ~300MB:
|
||||
|
||||
1. **Open API for Yealink Management Cloud Service V4X.pdf** (164 pages, 1.1MB)
|
||||
- 9 chunks, 20 pages each
|
||||
- Directory: `open-api-for-yealink-management-cloud-service-v4x/`
|
||||
- **KEY:** SIP account schema (chunk-03, pages 41-60)
|
||||
|
||||
2. **YMCS 4X Enterprise Open API Webhook.pdf** (5 pages, 47KB)
|
||||
- 1 chunk
|
||||
- Directory: `ymcs-4x-enterprise-open-api-webhook/`
|
||||
|
||||
3. **Yealink Management Cloud Service(YMCS)_User Guide.pdf** (953 pages, 90MB)
|
||||
- 48 chunks, 20 pages each
|
||||
- Directory: `yealink-management-cloud-serviceymcs_user-guide/`
|
||||
|
||||
4. **Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf** (84 pages, 210MB)
|
||||
- 5 chunks, 20 pages each
|
||||
- Directory: `yealink-management-cloud-serviceymcs_channel-user-guide/`
|
||||
|
||||
**Total:** 63 markdown files, ~1MB
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Find SIP Account Provisioning
|
||||
- **chunk-03** (pages 41-60): Add SIP account endpoint and schema
|
||||
- **chunk-04** (pages 61-80): SIP account management operations
|
||||
- See: `../SIPSERVER_SCHEMA.md` for critical field formats
|
||||
|
||||
### Find Device Management
|
||||
- **chunk-02** (pages 21-40): Device operations
|
||||
- **chunk-03** (pages 41-60): Bind/unbind accounts to devices
|
||||
|
||||
### Search All Chunks
|
||||
|
||||
```bash
|
||||
# Search for a topic across all chunks
|
||||
grep -r "your search term" .
|
||||
|
||||
# Find which chunk contains specific API endpoint
|
||||
grep -r "POST /v2/dm/" .
|
||||
|
||||
# List all chunks for a specific PDF
|
||||
ls -1 open-api-for-yealink-management-cloud-service-v4x/
|
||||
```
|
||||
|
||||
## How Chunks Were Created
|
||||
|
||||
Script: `../scripts/chunk-pdf-docs.py`
|
||||
|
||||
```bash
|
||||
# Process all PDFs
|
||||
python3 ../scripts/chunk-pdf-docs.py --all --pages-per-chunk 20
|
||||
|
||||
# Process single PDF
|
||||
python3 ../scripts/chunk-pdf-docs.py ~/Downloads/example.pdf --output-dir ./custom-output
|
||||
|
||||
# Extract just table of contents
|
||||
python3 ../scripts/chunk-pdf-docs.py ~/Downloads/example.pdf --toc-only
|
||||
```
|
||||
|
||||
## File Naming Convention
|
||||
|
||||
```
|
||||
{PDF-stem}-chunk-{number:02d}-p{start}-{end}.md
|
||||
```
|
||||
|
||||
Examples:
|
||||
- `Open API for Yealink Management Cloud Service V4X-chunk-03-p41-60.md`
|
||||
- `Yealink Management Cloud Service(YMCS)_User Guide-chunk-01-p1-20.md`
|
||||
|
||||
Each chunk includes:
|
||||
- Source PDF name
|
||||
- Page range (X-Y of total)
|
||||
- Chunk number
|
||||
- Full extracted text with layout preserved
|
||||
|
||||
## Critical Findings
|
||||
|
||||
### SIP Account sipServer1 Field (HTTP 412 Fix)
|
||||
|
||||
**Problem:** YMCS API returns HTTP 412 "Parameter error" on sipServer1 field
|
||||
|
||||
**Solution:** sipServer1 is an **object**, not a string:
|
||||
|
||||
```json
|
||||
"sipServer1": {
|
||||
"host": "pbx.packetdial.com",
|
||||
"port": 5060
|
||||
}
|
||||
```
|
||||
|
||||
See `../SIPSERVER_SCHEMA.md` for complete schema and examples.
|
||||
|
||||
## Tools Used
|
||||
|
||||
- **poppler-utils** (pdftotext, pdfinfo) - PDF text extraction
|
||||
- Install: `brew install poppler`
|
||||
- **Python 3** - Chunking script
|
||||
@@ -0,0 +1,825 @@
|
||||
# Open API for Yealink Management Cloud Service V4X.pdf - Pages 1-20
|
||||
|
||||
**Source:** Open API for Yealink Management Cloud Service V4X.pdf
|
||||
**Pages:** 1-20 of 164
|
||||
**Chunk:** 1
|
||||
|
||||
---
|
||||
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
|
||||
Open API for Yealink Management
|
||||
Cloud Service V4X
|
||||
1. YMCS APIs
|
||||
1.1 Introduction
|
||||
YMCS Open API provides third-party developers with a portal to securely use
|
||||
device management services. Through YMCS APIs, developers can use YMCS's
|
||||
device management, account management, configuration management and
|
||||
other functions.
|
||||
YMCS API is a REST-like API based on HTTP. The REST-like style indicates that the
|
||||
resource is tagged using a URI and allows access to the API via the HTTP
|
||||
protocol. The API relies on HTTP semantics and methods.
|
||||
In order to ensure the security of using the YMCS API, the transport protocol is
|
||||
unified using HTTPS and all requests need to be authenticated. If the YMCS API
|
||||
is used without carrying the correct identity credentials information, the request
|
||||
will be rejected outright. More information about YMCS authentication will be
|
||||
detailed in 1.2.2 Authentication.
|
||||
The YMCS platform limits the frequency of API calls to ensure system stability.
|
||||
Most endpoints are rate-limited to 50 requests per second. This rate limit is at
|
||||
the enterprise level, for each enterprise that supports the YMCS API, we allow 50
|
||||
requests per second. More information on rate limiting is detailed in Invoking Rate
|
||||
Limiting.
|
||||
|
||||
1.2 Use YMCS APIs
|
||||
YMCS APIs allow developers to access and manipulate resources under YMCS,
|
||||
including but not limited to device management, account management,
|
||||
configuration management, and other operations. This chapter will describe
|
||||
how to correctly call the YMCS API.
|
||||
YMCS API
|
||||
1 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
Version: 1.0.0
|
||||
Host:
|
||||
If your enterprise is in the EU region: eu-api.ymcs.yealink.com
|
||||
If your enterprise is in the US region: us-api.ymcs.yealink.com
|
||||
If your enterprise is in the AU region: au-api.ymcs.yealink.com
|
||||
Protocols: HTTPS
|
||||
Accepts: application/json
|
||||
Responds With: application/json
|
||||
|
||||
Authentication
|
||||
Every HTTP request made to the YMCS API must go through authentication. This
|
||||
operation is to ensure whether the client accessing the service is a registered
|
||||
user of the system. During the process of authentication, OAuth2.0 protocol will
|
||||
be used.
|
||||
Before calling the API, you need to obtain the Client ID and Client Secret from
|
||||
the YMCS platform to apply for an access token. An enterprise can only apply for
|
||||
one set of Client ID and Client Secret.
|
||||
Process Description
|
||||
The process for a user to request access tokens and initiate requests is as
|
||||
follows:
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
|
||||
1. The third-party application server initiates and sends a request, carrying the Client ID and Client Secret, to the
|
||||
YMCS API server to access a token.
|
||||
2. The API server verifies whether the Client ID and Client Secret information is correct.
|
||||
3. Yealink API server returns access token after successful verification.
|
||||
4. The third-party application server initiates a business request and carries an access token.
|
||||
5. Yealink API server checks for the existence of an access token, and then verifies the validity of the access
|
||||
token.
|
||||
6. Yealink API server forwards the request to the Yealink business server.
|
||||
7. Yealink business server will return the processed result to the Yealink API server.
|
||||
8. The API server will pass the response result to the third-party application server.
|
||||
|
||||
|
||||
If the access token is invalid, you will need to provide the corresponding code
|
||||
to retrieve the token from the server again.
|
||||
|
||||
Apply for access token
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/token
|
||||
Request parameters
|
||||
|
||||
3 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Param Parame Data Requ Description
|
||||
eter ter Type ired
|
||||
Type
|
||||
Author Header String Yes Basic
|
||||
ization base64Encode(client_id:client_secret),
|
||||
connect Client ID and Client Secret with
|
||||
a colon, and then perform Base64
|
||||
encoding.
|
||||
times Header String Yes Timestamp, the number of
|
||||
tamp milliseconds from January 1, 1970,
|
||||
00:00:00 to now.
|
||||
nonce Header String Yes Random number, maximum length 32
|
||||
bits
|
||||
grant_ Body String Yes client_credentials
|
||||
type
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
200 Operation successful, see response parameters.
|
||||
400 Client parameter transmission exception, see exception response
|
||||
parameters for details.
|
||||
401 Authentication failed, see exception response parameters.
|
||||
500 Server exception, see exception response parameters for details.
|
||||
|
||||
Response parameters
|
||||
|
||||
Parameter Data Type Description
|
||||
access_token String access token
|
||||
token_type String bearer
|
||||
expires_in Long Access token validity period, in seconds.
|
||||
|
||||
Exception response parameters
|
||||
|
||||
Par Data Description
|
||||
ame Type
|
||||
ter
|
||||
4 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
erro String Provide error codes according to the definition of the OAuth2
|
||||
r protocol. Error coded can be used to categorize and handle
|
||||
errors.
|
||||
cod String Server-defined error code, used for quick problem
|
||||
e localization.
|
||||
requ String Request ID generated by the server to track the execution
|
||||
estI status of the request on the server side. It can help
|
||||
d developers quickly identify issues.
|
||||
mes String Clear and concise error Description that can be understood
|
||||
sage by end users.
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/token HTTP/1.1
|
||||
Content-Type: application/json
|
||||
Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
|
||||
|
||||
{
|
||||
"grant_type": "client_credentials"
|
||||
}
|
||||
|
||||
|
||||
Example of response parameters
|
||||
|
||||
httpHTTP/1.1 200 OK
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
Cache-Control: no-store
|
||||
Pragma: no-cache
|
||||
|
||||
{
|
||||
"access_token": "[JWT TOKEN]",
|
||||
"token_type": "bearer",
|
||||
"expires_in": 86400
|
||||
}
|
||||
|
||||
|
||||
Exception response parameters
|
||||
|
||||
httpHTTP/1.1 400 Bad Request
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
Cache-Control: no-store
|
||||
|
||||
5 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
Pragma: no-cache
|
||||
|
||||
{
|
||||
"error": "invalid_request",
|
||||
"code": "70011",
|
||||
"requestId": "255d1aef",
|
||||
"message": "The provided value for the input parameter 'grant_type' is not valid."
|
||||
}
|
||||
|
||||
|
||||
Initiate business request
|
||||
All API requests must be made via HTTPS. The base URL for requests is https://
|
||||
api.ymcs.yealink.com/v2/. The complete URL varies depending on the resource of
|
||||
|
||||
the operation.
|
||||
Each time you request the API, you must provide 3 HTTP Request Headers, as
|
||||
follows:
|
||||
|
||||
Name Data Type Description
|
||||
Authoriza String Authentication information. The format is: Bearer
|
||||
tion [ACCESS TOKEN]
|
||||
|
||||
timestam String Timestamp, the number of milliseconds from
|
||||
p January 1, 1970, 00:00:00 to now.
|
||||
nonce String Random number, maximum length 32 bits
|
||||
|
||||
HTTP Request Header Example
|
||||
|
||||
httpAuthorization: Bearer [ACCESS TOKEN]
|
||||
timestamp: 1568693976264
|
||||
nonce: 097e0ac619ba41f68f16f1955787feb9
|
||||
|
||||
|
||||
1.3 Error Definitions
|
||||
Yealink API uses HTTP status codes to reflect the success or failure of request
|
||||
operations. 2XX status codes indicate successful operations, while 4XX or 5XX
|
||||
status codes indicate operation errors. If an erroneous status code is received,
|
||||
the error code and error message in the response body can be used to
|
||||
understand the reason for the error.
|
||||
|
||||
6 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Status code Description Scenario example
|
||||
2XX Operation successful
|
||||
400 Request data error Invalid or incomplete
|
||||
request data.
|
||||
401Authenticati Authentication error The request did not carry
|
||||
on error an access token.
|
||||
403 Access to certain resources Authentication failed
|
||||
is not allowed
|
||||
404 No data matching the No data found.
|
||||
request
|
||||
429 Request rate exceeds Request too frequent
|
||||
frequency limit
|
||||
500 Server Error Internal server error
|
||||
|
||||
Error object definition
|
||||
Error object
|
||||
|
||||
Na Data Description
|
||||
me Typ
|
||||
e
|
||||
cod Stri Error codes defined by the server, used for quick problem
|
||||
e ng localization.
|
||||
req Stri Request ID generated by the server, used for tracking the
|
||||
uest ng execution status of requests on the server. It helps developers
|
||||
Id quickly locate issues.
|
||||
mes Stri A simple and clear error Description that can be understood by
|
||||
sag ng the end user.
|
||||
e
|
||||
deta Error List of details that caused the error, may be empty
|
||||
ils Detai
|
||||
l[]
|
||||
|
||||
ErrorDetail object
|
||||
|
||||
Name Data Description
|
||||
Type
|
||||
7 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
field String Error in the request parameter name
|
||||
messag String A simple and clear error Description that can be
|
||||
e understood by the end user.
|
||||
|
||||
Error Response Example
|
||||
|
||||
json{
|
||||
"code": "{errorCode}",
|
||||
"requestId": "{requestId}",
|
||||
"message": "Validation Failed",
|
||||
"details": [
|
||||
{
|
||||
"field": "email",
|
||||
"message": "Invalid field"
|
||||
},
|
||||
{
|
||||
"field": "type",
|
||||
"message": "Invalid field"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Opera Description Description
|
||||
tional
|
||||
code
|
||||
90020 Operation successful Operate Successfully
|
||||
0
|
||||
90040 Incorrect request parameters Request parameters
|
||||
0 are incorrect
|
||||
90040 The user has not logged in or the login has User is not logged in
|
||||
1 expired, please log in again or the account has
|
||||
expired, please log in
|
||||
again
|
||||
90040 The request has been forbidden. This request is
|
||||
3 forbidden
|
||||
90040 The requested resource cannot be found. Requested resource is
|
||||
8 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
4 not found
|
||||
90040 Request timed out, please try again later. Time out, please try
|
||||
8 again
|
||||
90040 Conflict request. Request conflict
|
||||
9
|
||||
90041 Concurrent editing error. Concurrent editing
|
||||
2 error
|
||||
90042 Too many requests. Too Many Requests
|
||||
9
|
||||
90044 Session expired. Login Time-out
|
||||
0
|
||||
90050 The server is busy, please try again later. The server is busy,
|
||||
0 please try again later
|
||||
90050 This operation is not supported. Not Implemented
|
||||
1
|
||||
90050 When a server acting as a gateway or proxy Bad Gateway
|
||||
2 attempts to process a request, it receives an
|
||||
invalid response from the upstream server.
|
||||
90050 Service Unavailable. Service Unavailable
|
||||
3
|
||||
90050 The upstream server is not responding. Gateway Timeout
|
||||
4
|
||||
90051 Internal server error Server Internal Error
|
||||
1
|
||||
90059 Unknown error unknown mistake
|
||||
9
|
||||
90040 Parameters cannot be null Cannot be null
|
||||
0
|
||||
90040 Parameters cannot be null Cannot be empty
|
||||
0
|
||||
90040 The parameter length is incorrect. Incorrect length
|
||||
0
|
||||
90040 ID cannot be empty. ID cannot be empty
|
||||
|
||||
9 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
0
|
||||
90040 Resource does not exist The resource does not
|
||||
0 exist or has been
|
||||
deleted
|
||||
80000 Mac is not legal. Invalid MAC
|
||||
1
|
||||
80000 Invalid SN. SN is invalid
|
||||
2
|
||||
80000 Resource already exists. Resource already
|
||||
3 exists
|
||||
80000 The device has been added by another MAC has been added
|
||||
4 company. by another
|
||||
enterprise/
|
||||
organization
|
||||
80000 Device type illegal Device Type is invalid
|
||||
5
|
||||
80000 The number of devices added in a batch The number of added
|
||||
6 exceeds the limit devices exceeds the
|
||||
limit
|
||||
80000 Invalid parameters. Incorrect parameter
|
||||
7 format
|
||||
80000 Data exceeds limit. Data exceeds limit
|
||||
8
|
||||
80013 Account already exists Account already exists
|
||||
0
|
||||
80020 The authentication username and Username and
|
||||
0 password must appear in pairs. password must
|
||||
appear in pairs
|
||||
|
||||
1.4 Invoke Rate Limiting
|
||||
In order to maintain the reliability of the YMCS API platform, our API has the
|
||||
following rate limits.
|
||||
The rate limit for the normal API is 50 requests/second unless otherwise noted.
|
||||
Please control the frequency of your application calls and do not exceed the
|
||||
10 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
access rate limit or you will receive a 429 status response.
|
||||
Invokers of the YMCS API shall retry Error 429 using the exponential backoff
|
||||
algorithm and with a minimum delay of 30 seconds.
|
||||
|
||||
2. Device Management
|
||||
2.1 Device Basic Information Management
|
||||
2.1.1 Add Devices
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/devices
|
||||
Body parameter
|
||||
|
||||
Paramet Data Required Description
|
||||
er Type
|
||||
mac String Yes Device MAC, minimum length 12,
|
||||
maximum length 17 characters
|
||||
sn String Yes SN code, maximum length 128
|
||||
deviceT Integer Yes Device Type 1: Phone Device 3: Room
|
||||
ype Device
|
||||
modelId String Yes Model ID
|
||||
name String No Device name, maximum length 128
|
||||
siteId String No Site ID
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
201 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Response parameters
|
||||
|
||||
|
||||
11 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Parameter Data Type Description
|
||||
id String The device ID.
|
||||
mac String The device MAC address.
|
||||
sn String The group ID.
|
||||
name String The device name.
|
||||
modelId String The device model ID.
|
||||
siteId String The site ID.
|
||||
programVersion String The version number of the device
|
||||
firmware.
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/devices HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"mac":"001565bbb1a9",
|
||||
"sn":"1106312113402006",
|
||||
"name":"my t54s",
|
||||
"deviceType":1
|
||||
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 201 Created
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"id": "8d07a56207074d26b61026099625b9e2",
|
||||
"mac":"001565bbb1a9",
|
||||
"sn":"1106312113402006",
|
||||
"name":"my t54s",
|
||||
"modelId":"61e659e4d78d42ebada88ef1eb751b64",
|
||||
"siteId":"a624453e1cbb44ecb9bb6ee31731a856",
|
||||
"programVersion":"70.83.0.68"
|
||||
}
|
||||
|
||||
|
||||
12 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
2.1.2 Add Device in Batches
|
||||
Note: You can add up to 100 devices at a time.
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/addDevices
|
||||
Body parameter
|
||||
|
||||
Paramete Data Type Required Description
|
||||
r
|
||||
mac String Yes Device MAC, minimum length 12,
|
||||
maximum length 17
|
||||
sn String Yes SN code, maximum length 128
|
||||
deviceTyp Integer Yes Device Type 1: Phone Device 3:
|
||||
e Room Device
|
||||
modelId String Yes Model ID
|
||||
name String No Device name, maximum length
|
||||
128
|
||||
siteId String No Site 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 The total number of batch additions.
|
||||
successCoun Integer The total number of successful additions.
|
||||
t
|
||||
|
||||
13 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
failureCount Integer The total number of failures.
|
||||
errors AddError[] Error message.
|
||||
|
||||
AddError object
|
||||
|
||||
parameter Data Type Description
|
||||
mac String The device MAC address.
|
||||
sn String The device SN address.
|
||||
errorInfo String Error message.
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/addDevices HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
[{
|
||||
"mac":"3a1565bbb1a9",
|
||||
"sn":"1106312113402006",
|
||||
"name":"my t54s",
|
||||
"modelId":"61e659e4d78d42ebada88ef1eb751b64",
|
||||
"deviceType":1
|
||||
|
||||
}]
|
||||
|
||||
|
||||
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":"device.mac.invalid"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
14 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
2.1.3 Add device without SN
|
||||
Note: You can add up to 100 devices at a time.
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/addDevicesByMac
|
||||
Body parameter
|
||||
|
||||
Param ParameterT Data Requi Description
|
||||
eter ype Type red
|
||||
mac Body String Yes Device MAC, minimum length
|
||||
12, maximum length 17
|
||||
device Body Integer Yes Device Type 1: Phone Device 3:
|
||||
Type Room Device
|
||||
model Body String Yes Model ID
|
||||
Id
|
||||
name Body String No Device name, maximum length
|
||||
128
|
||||
siteId Body String No Site 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 The total number of batch additions.
|
||||
successCoun Integer The total number of successful additions.
|
||||
t
|
||||
failureCount Integer The total number of failures.
|
||||
15 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
errors AddError[] Error message.
|
||||
|
||||
Parameter Data Type Description
|
||||
mac String The device MAC address.
|
||||
sn String The device SN address.
|
||||
errorInfo String Error message.
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/addDevicesByMac HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
[{
|
||||
"mac":"3a1565bbb1a9",
|
||||
"name":"my t54s",
|
||||
"modelId":"61e659e4d78d42ebada88ef1eb751b64",
|
||||
"deviceType":1
|
||||
|
||||
}]
|
||||
|
||||
|
||||
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":"device.mac.invalid"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.1.4 Delete Device
|
||||
Request Method
|
||||
|
||||
16 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
DELETE
|
||||
Request URL
|
||||
/v2/dm/devices/{deviceId}
|
||||
PATH parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceId String Yes The device ID.
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpDELETE /v2/dm/devices/e33b8f25247e45de84dd4c74503b241a HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
2.1.5 Delete Devices in Batches
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/delDevices
|
||||
Body parameter
|
||||
|
||||
Parame Data Req Description
|
||||
ter Type uire
|
||||
d
|
||||
|
||||
17 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
device Integ Yes Device Type 1: Phone Device 3: Room Device
|
||||
Type er
|
||||
deviceI Strin No Indicates the type of device identifier, default id,
|
||||
dType g optional mac, id
|
||||
deviceI Strin Yes Device identifier, maximum length 200
|
||||
ds g[]
|
||||
|
||||
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
|
||||
|
||||
httpPOST /v2/dm/delDevices HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
|
||||
18 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"deviceType":1,
|
||||
"deviceIds":["001565bbb1a9","001567"],
|
||||
"deviceIdType":"mac"
|
||||
}
|
||||
|
||||
|
||||
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"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.1.6 Device List
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/listDevices
|
||||
Body parameter
|
||||
|
||||
Par Data Req Description
|
||||
ame Type uir
|
||||
ter ed
|
||||
ski Long No Number of skipped records, default is 0
|
||||
p
|
||||
limi Long No Maximum number of records to retrieve, default is 10,
|
||||
t maximum is 100.
|
||||
aut Bool No Whether to respond with the total count, it is
|
||||
oCo ean recommended to set it to true when querying the first
|
||||
unt page, and pass false for subsequent page turns.
|
||||
|
||||
19 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
filte Filter No search parameters
|
||||
r
|
||||
|
||||
Filter object definition
|
||||
|
||||
Para Dat Re Description
|
||||
mete a qu
|
||||
r Ty ire
|
||||
pe d
|
||||
mac Str No Device MAC fuzzy search keyword, maximum length 17,
|
||||
ing supports with : or -, such as 00:15:65:bb:b1:a9
|
||||
model Str No Model ID
|
||||
Id ing
|
||||
devic Int No Device status, 1: online, 0: offline, -1: not reported
|
||||
eStat ege
|
||||
us r
|
||||
accou Int No Account status, 1: Registered 2: dnd 3: Unregistered
|
||||
ntSta ege
|
||||
tus r
|
||||
devic Int No Device type status, 1: Phone Device 3: Room Device, if
|
||||
eType ege not filled in, it means all.
|
||||
r
|
||||
siteId Str No Site ID
|
||||
ing
|
||||
|
||||
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 The offset value.
|
||||
20 / 164
|
||||
@@ -0,0 +1,886 @@
|
||||
# Open API for Yealink Management Cloud Service V4X.pdf - Pages 21-40
|
||||
|
||||
**Source:** Open API for Yealink Management Cloud Service V4X.pdf
|
||||
**Pages:** 21-40 of 164
|
||||
**Chunk:** 2
|
||||
|
||||
---
|
||||
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
limit Long The maximum returned number.
|
||||
total Long The total number.
|
||||
data Device[] Device information array
|
||||
|
||||
Device object definition
|
||||
|
||||
Paramete Data Description
|
||||
r Type
|
||||
id Strin device id
|
||||
g
|
||||
mac Strin Device MAC
|
||||
g
|
||||
sn Strin Device SN
|
||||
g
|
||||
name Strin Device Name
|
||||
g
|
||||
modelId Strin Model ID
|
||||
g
|
||||
siteId Strin Site ID
|
||||
g
|
||||
programV Strin Device firmware version number
|
||||
ersion g
|
||||
deviceSta Strin Device status, online: online, offline: offline, pending:
|
||||
tus g not reported
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/listDevices HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 20,
|
||||
"autoCount": true,
|
||||
"filter":{
|
||||
"deviceStatus":1,
|
||||
|
||||
21 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"siteId":"a624453e1cbb44ecb9bb6ee31731a856"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
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",
|
||||
"name":"my t54s",
|
||||
"modelId":"61e659e4d78d42ebada88ef1eb751b64",
|
||||
"siteId":"a624453e1cbb44ecb9bb6ee31731a856",
|
||||
"programVersion":"70.83.0.68",
|
||||
"deviceStatus":"online"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.1.7 Edit Device
|
||||
Request Method
|
||||
PATCH
|
||||
Request URL
|
||||
/v2/dm/devices/{deviceId}
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceId String Yes The device ID address.
|
||||
|
||||
Body parameter
|
||||
|
||||
Paramete Data Require Description
|
||||
r Type d
|
||||
|
||||
22 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
name String No Device name, maximum length 128
|
||||
siteId String No Site ID
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPATCH /v2/dm/devices/8d07a56207074d26b61026099625b9e2 HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name":"my t54s2"
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
2.1.8 Device Details
|
||||
Request Method
|
||||
GET
|
||||
Request URL
|
||||
/v2/dm/devices/{deviceId}
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceId String Yes The device ID.
|
||||
|
||||
HTTP status code
|
||||
|
||||
|
||||
23 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Code Description
|
||||
200 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Response parameters
|
||||
|
||||
Paramet Data Description
|
||||
er Type
|
||||
id String device id
|
||||
mac String Device MAC
|
||||
sn String group id
|
||||
name String Device Name
|
||||
modelId String Model ID
|
||||
modelN String Model Name
|
||||
ame
|
||||
siteId String Site ID
|
||||
siteNam String Site Name
|
||||
e
|
||||
lanIp String Intranet IP
|
||||
deviceSt String Device status, online: online, offline: offline,
|
||||
atus pending: not reported
|
||||
programV String Firmware version
|
||||
ersion
|
||||
lastRepo long Last reporting time
|
||||
rtTime
|
||||
accounts ReportAcc Reported account information
|
||||
ount[]
|
||||
|
||||
ReportAccount object definition
|
||||
|
||||
Paramet Data Description
|
||||
er Type
|
||||
|
||||
24 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
accountI String Account ID
|
||||
d
|
||||
lineId Intege Account line, starting from 1
|
||||
r
|
||||
accountT Intege Account type: 0: SIP, 1: H323, 2: SFB
|
||||
ype r
|
||||
accountS String Account server address
|
||||
erver
|
||||
register String Registration Name
|
||||
Name
|
||||
usernam String User Name
|
||||
e
|
||||
status Intege Account status: 1: Registered 2: dnd 3: Not registered 4:
|
||||
r Unknown
|
||||
|
||||
Example Request
|
||||
|
||||
httpGET /v2/dm/devices/8d07a56207074d26b61026099625b9e2 HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"id": "8d07a56207074d26b61026099625b9e2",
|
||||
"mac":"001565bbb1a9",
|
||||
"sn":"1106312113402006",
|
||||
"name":"my t54s",
|
||||
"modelId":"61e659e4d78d42ebada88ef1eb751b64",
|
||||
"modelName":"SIP-T54S",
|
||||
"siteId":"a624453e1cbb44ecb9bb6ee31731a856",
|
||||
"siteName":"mysite",
|
||||
"lanIp":"10.50.198.6",
|
||||
"deviceStatus":"online",
|
||||
"programVersion":"70.83.0.68",
|
||||
"lastReportTime":1711093807136,
|
||||
"accounts":[{
|
||||
25 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"accountId":"604e67944c7c43fe8b66099254ec3439"
|
||||
"lineId":1,
|
||||
"accountType":0,
|
||||
"accountServer":"10.200.108.48",
|
||||
"registerName":"1000",
|
||||
"username":"1000",
|
||||
"status":0
|
||||
|
||||
},{
|
||||
"accountId":"a45a6b4a7e0447b8a6c3f2839d902acd"
|
||||
"lineId":2,
|
||||
"accountType":0,
|
||||
"accountServer":"10.200.108.48",
|
||||
"registerName":"2000",
|
||||
"username":"2000",
|
||||
"status":0
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.1.9 Device Combination Configuration Query
|
||||
Request Method
|
||||
GET
|
||||
Request URL
|
||||
/v2/dm/devices/{deviceId}/configs
|
||||
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
|
||||
|
||||
26 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Parameter Data Description
|
||||
Type
|
||||
deviceConfig String Device MAC Configuration
|
||||
siteConfig String Device Site Configuration
|
||||
globalConfig String Enterprise Configurations
|
||||
enforceConfig String Site forced inheritance configuration
|
||||
|
||||
Example Request
|
||||
|
||||
httpGET /v2/dm/devices/8d07a56207074d26b61026099625b9e2/configs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"deviceConfig": "account.1.auth_name = test1101",
|
||||
"siteConfig":"lang.gui=English",
|
||||
"globalConfig":"auto_provision.server.url=\r\nlang.gui=English",
|
||||
"enforceConfig":"security.user_password=user2"
|
||||
}
|
||||
|
||||
|
||||
2.2 Device Group Management
|
||||
2.2.1 Add Group
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/deviceGroups
|
||||
Body parameter
|
||||
|
||||
Paramete Data Requi Description
|
||||
r Type red
|
||||
name String Yes Group name, length 64
|
||||
deviceTyp Integer Yes Device Type 1: Phone Device 3: Room
|
||||
27 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
e Device
|
||||
Descripti String No Group Description information, length 256
|
||||
on
|
||||
|
||||
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 group ID.
|
||||
name String Group Name
|
||||
deviceType Integer Device Types
|
||||
description String Group description information
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/deviceGroups HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name":"t54sgroup",
|
||||
"deviceType":1,
|
||||
"Description":"test"
|
||||
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 201 Created
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
|
||||
|
||||
28 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
{
|
||||
"id": "00884cef841e48f4acd213c084e65f67",
|
||||
"name":"t54sgroup",
|
||||
"deviceType":1,
|
||||
"Description":"test"
|
||||
}
|
||||
|
||||
|
||||
2.2.2 Edit Group
|
||||
Request Method
|
||||
PATCH
|
||||
Request URL
|
||||
/v2/dm/deviceGroups/{deviceGroupId}
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceGroupId String Yes Group ID
|
||||
|
||||
Body parameter
|
||||
|
||||
Paramete Data Requi Description
|
||||
r Type red
|
||||
name String Yes Group name, length 64
|
||||
deviceTyp Integer Yes Device Type 1: Phone Device 3: Room
|
||||
e Device
|
||||
Descripti String No Group Description information, length 256
|
||||
on
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
29 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
httpPATCH /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name":"t54sgroup2",
|
||||
"deviceType":1,
|
||||
"Description":"test2"
|
||||
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
2.2.3 Group List
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/listDeviceGroups
|
||||
Body parameter
|
||||
|
||||
Param Data Requir Description
|
||||
eter Type ed
|
||||
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.
|
||||
autoCo Boolean No Whether to respond with the total count, it is
|
||||
unt recommended to set it to true when querying
|
||||
the first page, and pass false for subsequent
|
||||
page turns.
|
||||
filter Filter No search parameters
|
||||
|
||||
Filter object definition
|
||||
|
||||
Para Data Req Description
|
||||
mete uir
|
||||
|
||||
30 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
r Typ ed
|
||||
e
|
||||
devi Inte No Device type status, 1: Phone Device 3: Room Device, if
|
||||
ceTy ger not filled in, it means all.
|
||||
pe
|
||||
|
||||
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 DeviceGroup[] DeviceGroup information array
|
||||
|
||||
DeviceGroup object definition
|
||||
|
||||
Parameter Data Description
|
||||
Type
|
||||
id String Group ID
|
||||
name String Group name, length 64
|
||||
deviceType Integer Device Type 1: Phone Device 3: Room Device
|
||||
Description String Group Description information, length 256
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/listDeviceGroups HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
|
||||
31 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"autoCount": true,
|
||||
"filter":{
|
||||
"deviceType":1
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"total": 1,
|
||||
"data":[{
|
||||
"id": "00884cef841e48f4acd213c084e65f67",
|
||||
"name":"t54sgroup",
|
||||
"deviceType":1,
|
||||
"Description":"test"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.2.4 Delete Group
|
||||
Request Method
|
||||
DELETE
|
||||
Request URL
|
||||
/v2/dm/deviceGroups/{deviceGroupId}
|
||||
PATH parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceGroupId String Yes Group ID
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
|
||||
32 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpDELETE /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67 HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
2.2.5 Add Device to Group
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/deviceGroups/{deviceGroupId}/addDevices
|
||||
PATH parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceGroupId String Yes Group ID
|
||||
|
||||
Body parameter
|
||||
|
||||
Paramete Data Require Description
|
||||
r Type d
|
||||
deviceIds String[] Yes Device ID list, limited to 200.
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
200 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
33 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
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/deviceGroups/00884cef841e48f4acd213c084e65f67/addDevices
|
||||
HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"deviceIds":
|
||||
["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"]
|
||||
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200 OK
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"total": 2,
|
||||
"successCount":1,
|
||||
"failureCount":1,
|
||||
"errors":[{
|
||||
34 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"field":"00099642675e4d4bb5e91fd9ae5ce585",
|
||||
"msg":"The resource does not exist or has been deleted"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.2.6 Remove devices from the group
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/deviceGroups/{deviceGroupId}/delDevices
|
||||
PATH parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceGroupId String Yes Group ID
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
35 / 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/deviceGroups/00884cef841e48f4acd213c084e65f67/delDevices
|
||||
HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"deviceIds":
|
||||
["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"]
|
||||
|
||||
}
|
||||
|
||||
|
||||
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"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.2.7 Query Device List within Group
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
36 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
/v2/dm/deviceGroups/{deviceGroupId}/listDevices
|
||||
PATH parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
deviceGroupId String Yes Group 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
|
||||
fil Fil N search parameters
|
||||
te te o
|
||||
r r
|
||||
|
||||
Filter object definition
|
||||
|
||||
Para Dat Re Description
|
||||
mete a qu
|
||||
r Ty ire
|
||||
pe d
|
||||
mac Str No Device MAC fuzzy search keyword, maximum length 17,
|
||||
ing supports with : or -, such as 00:15:65:bb:b1:a9
|
||||
mode Str No Model ID
|
||||
lId ing
|
||||
37 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
devic Int No Device status, 1: online, 0: offline, -1: not reported
|
||||
eStat ege
|
||||
us r
|
||||
|
||||
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
|
||||
|
||||
Paramete Data Description
|
||||
r Type
|
||||
id Strin device id
|
||||
g
|
||||
mac Strin Device MAC
|
||||
g
|
||||
sn Strin Device SN
|
||||
g
|
||||
name Strin Device Name
|
||||
g
|
||||
modelId Strin Model ID
|
||||
g
|
||||
siteId Strin Site ID
|
||||
g
|
||||
38 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
programV Strin Device firmware version number
|
||||
ersion g
|
||||
deviceSta Strin Device status, online: online, offline: offline, pending:
|
||||
tus g not reported
|
||||
|
||||
|
||||
httpPOST /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67/listDevices
|
||||
HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"autoCount": true
|
||||
}
|
||||
|
||||
|
||||
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",
|
||||
"name":"my t54s",
|
||||
"modelId":"61e659e4d78d42ebada88ef1eb751b64",
|
||||
"siteId":"a624453e1cbb44ecb9bb6ee31731a856",
|
||||
"programVersion":"70.83.0.68",
|
||||
"deviceStatus":"online"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
2.3 Device Control
|
||||
2.3.1 Device Restart
|
||||
Request Method
|
||||
39 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/device/reboot
|
||||
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 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
|
||||
|
||||
40 / 164
|
||||
@@ -0,0 +1,891 @@
|
||||
# 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
|
||||
@@ -0,0 +1,883 @@
|
||||
# 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
|
||||
|
||||
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/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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
@@ -0,0 +1,884 @@
|
||||
# Open API for Yealink Management Cloud Service V4X.pdf - Pages 81-100
|
||||
|
||||
**Source:** Open API for Yealink Management Cloud Service V4X.pdf
|
||||
**Pages:** 81-100 of 164
|
||||
**Chunk:** 5
|
||||
|
||||
---
|
||||
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
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
|
||||
Description String Description, length 256
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
200 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/listSiteConfigs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"autoCount": true
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"total": 1,
|
||||
|
||||
81 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"data":[{
|
||||
"id": "8b7f1739ad6d4a578267d09b53a262a3",
|
||||
"name": "site1 config2",
|
||||
"siteId":"048a97f00ece46bd8d8bf97f5002992a",
|
||||
"deviceType":1,
|
||||
"modelId":"db249ca8f83f425baeda09214288d0a9",
|
||||
"Description":"test2"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
4.2.6 Push Subsite Configuration
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/siteConfigs/{configId}/push
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
configId String Yes The configuration ID.
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/siteConfigs/8b7f1739ad6d4a578267d09b53a262a3/push HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
|
||||
82 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
4.3 Phone Group Configuration Management
|
||||
4.3.1 Add Group Configuration
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/groupConfigs
|
||||
Body parameter
|
||||
|
||||
Paramete Data Requi Description
|
||||
r Type red
|
||||
name String Yes Group configuration name, length 64
|
||||
deviceGro String Yes Device Group ID
|
||||
upId
|
||||
deviceTyp Integer Yes Device Type 1: Phone Device
|
||||
e
|
||||
modelId String No Model ID, leaving it blank indicates all
|
||||
models
|
||||
content String No Configuration file content
|
||||
Descriptio String No Description, length 256
|
||||
n
|
||||
|
||||
Response parameters
|
||||
|
||||
Parameter Data Type Description
|
||||
id String Group Configuration ID
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
201 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
83 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
httpPOST /v2/dm/groupConfigs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "group config",
|
||||
"deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88",
|
||||
"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": "8faa39e34929425f85b4cd9925a2bbcb"
|
||||
}
|
||||
|
||||
|
||||
4.3.2 Edit Group Configuration
|
||||
Request Method
|
||||
PATCH
|
||||
Request URL
|
||||
/v2/dm/groupConfigs/{configId}
|
||||
Path parameter
|
||||
|
||||
Parameter Data Type Required Description
|
||||
configId String Yes Group Configuration ID
|
||||
|
||||
Body parameter
|
||||
|
||||
Paramete Data Requi Description
|
||||
r Type red
|
||||
name String Yes Group configuration name, length 64
|
||||
deviceGro String Yes Device Group ID
|
||||
|
||||
84 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
upId
|
||||
deviceTyp Integer Yes Device Type 1: Phone Device
|
||||
e
|
||||
modelId String No Model ID, leaving it blank indicates all
|
||||
models
|
||||
content String No Configuration file content
|
||||
Descriptio String No Description, length 256
|
||||
n
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPATCH /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"name": "group config2",
|
||||
"deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88",
|
||||
"deviceType":1,
|
||||
"modelId":"db249ca8f83f425baeda09214288d0a9",
|
||||
"content": "lang.wui=English\nlang.gui=English",
|
||||
"Description":"test2"
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
4.3.3 Delete Group Configuration
|
||||
Request Method
|
||||
85 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/delGroupConfigs
|
||||
Body parameter
|
||||
|
||||
Parame Data Requi Description
|
||||
ter Type red
|
||||
configI String[] Yes Group 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
|
||||
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
|
||||
|
||||
httpDELETE /v2/dm/delGroupConfigs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
86 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"configIds":
|
||||
["8faa39e34929425f85b4cd9925a2bbcb","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.3.4 Group Configuration Details
|
||||
Request Method
|
||||
GET
|
||||
Request URL
|
||||
/v2/dm/groupConfigs/{configId}
|
||||
Path parameter
|
||||
|
||||
Parameter Data Type Required Description
|
||||
configId String Yes Group Configuration ID
|
||||
|
||||
Response parameters
|
||||
|
||||
Parameter Data Description
|
||||
Type
|
||||
id String Group Configuration ID
|
||||
name String Group configuration name, length 64
|
||||
|
||||
87 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
deviceGroupId String Group ID
|
||||
deviceType Integer Device Type 1: Phone Device
|
||||
modelId String Model ID
|
||||
content String Configuration file content
|
||||
Description String Description, length 256
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
200 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpGET /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"id": "8faa39e34929425f85b4cd9925a2bbcb",
|
||||
"name": "group config2",
|
||||
"deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88",
|
||||
"deviceType":1,
|
||||
"modelId":"db249ca8f83f425baeda09214288d0a9",
|
||||
"content": "lang.wui=English\nlang.gui=English",
|
||||
"Description":"test2"
|
||||
}
|
||||
|
||||
|
||||
4.3.5 Group Configuration List
|
||||
Request Method
|
||||
POST
|
||||
|
||||
88 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Request URL
|
||||
/v2/dm/listGroupConfigs
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
Parameter Data Description
|
||||
Type
|
||||
id String Group Configuration ID
|
||||
name String Group configuration name, length 64
|
||||
deviceGroupId String Group ID
|
||||
deviceType Integer Device Type 1: Phone Device
|
||||
modelId String Model ID
|
||||
Description String Description, length 256
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
89 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
200 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/listGroupConfigs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"autoCount": true
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"total": 1,
|
||||
"data":[{
|
||||
"id": "8faa39e34929425f85b4cd9925a2bbcb",
|
||||
"name": "group config2",
|
||||
"deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88",
|
||||
"deviceType":1,
|
||||
"modelId":"db249ca8f83f425baeda09214288d0a9",
|
||||
"Description":"test2"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
4.3.6 Push Group Configuration
|
||||
Request Method
|
||||
POST
|
||||
|
||||
90 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Request URL
|
||||
/v2/dm/groupConfigs/{configId}/push
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
configId String Yes The configuration ID.
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb/push HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
4.4 Conference Room Equipment Configuration Management
|
||||
4.4.1 Save Device Configuration
|
||||
Request Method
|
||||
PUT
|
||||
Request URL
|
||||
/v2/dm/rooms/deviceConfigs
|
||||
Body parameter
|
||||
|
||||
Parameter Data Type Required Description
|
||||
deviceId String Yes Device ID
|
||||
content String Yes cfg file content
|
||||
91 / 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
|
||||
id String The device configuration ID.
|
||||
|
||||
Example Request
|
||||
|
||||
httpPUT /v2/dm/rooms/deviceConfigs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"deviceId": "8d07a56207074d26b61026099625b9e2",
|
||||
"content": "lang.wui=English\nlang.gui=English"
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200 OK
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"id": "d916a46b4557464c87c278cb37477bef"
|
||||
}
|
||||
|
||||
|
||||
4.4.2 Device Configuration Details
|
||||
Request Method
|
||||
GET
|
||||
Request URL
|
||||
/v2/dm/rooms/deviceConfigs/{configId}
|
||||
92 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
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
|
||||
|
||||
Parameter Data Type Description
|
||||
id String The device configuration ID.
|
||||
content String Configuration ID
|
||||
|
||||
Example Request
|
||||
|
||||
httpGET /v2/dm/rooms/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",
|
||||
"content":"#!version:1.0.0.1\naccount.1.codec.g722.enable=1"
|
||||
}
|
||||
|
||||
|
||||
4.4.3 Push Device Configuration
|
||||
Request Method
|
||||
POST
|
||||
93 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Request URL
|
||||
/v2/dm/rooms/deviceConfigs/{configId}/push
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
configId String Yes The configuration ID.
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/rooms/deviceConfigs/e33b8f25247e45de84dd4c74503b241a/push
|
||||
HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
4.4 Conference Room Equipment Configuration Management
|
||||
4.4.1 Save Device Configuration
|
||||
Request Method
|
||||
PUT
|
||||
Request URL
|
||||
/v2/dm/rooms/deviceConfigs
|
||||
Body parameter
|
||||
|
||||
Parameter Data Type Required Description
|
||||
deviceId String Yes Device ID
|
||||
|
||||
94 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
content String Yes cfg file content
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
200 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
|
||||
|
||||
httpPUT /v2/dm/rooms/deviceConfigs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"deviceId": "8d07a56207074d26b61026099625b9e2",
|
||||
"content": "lang.wui=English\nlang.gui=English"
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200 OK
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"id": "d916a46b4557464c87c278cb37477bef"
|
||||
}
|
||||
|
||||
|
||||
4.4.2 Device Configuration Details
|
||||
Request Method
|
||||
GET
|
||||
|
||||
|
||||
95 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Request URL
|
||||
/v2/dm/rooms/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
|
||||
|
||||
Parameter Data Type Description
|
||||
id String The device configuration ID.
|
||||
content String Configuration ID
|
||||
|
||||
Example Request
|
||||
|
||||
httpGET /v2/dm/rooms/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",
|
||||
"content":"#!version:1.0.0.1\naccount.1.codec.g722.enable=1"
|
||||
}
|
||||
|
||||
|
||||
4.4.3 Push Device Configuration
|
||||
96 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/rooms/deviceConfigs/{configId}/push
|
||||
Path parameter
|
||||
|
||||
parameter Data Type Required Description
|
||||
configId String Yes The configuration ID.
|
||||
|
||||
HTTP status code
|
||||
|
||||
Code Description
|
||||
204 Operation successful
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/rooms/deviceConfigs/e33b8f25247e45de84dd4c74503b241a/push
|
||||
HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 204
|
||||
|
||||
|
||||
5.RPS management
|
||||
5.1 RPS Device Management
|
||||
5.1.1 Add Device
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/rps/devices
|
||||
|
||||
97 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Body parameter
|
||||
|
||||
Parameter Data Requ Description
|
||||
Type ired
|
||||
mac String Yes Device MAC, minimum length 12, maximum
|
||||
length 17
|
||||
sn String Yes SN code, maximum length 128
|
||||
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
|
||||
201 Operation successful, see response parameters.
|
||||
400 Client parameter exception
|
||||
401 Authentication failed
|
||||
500 Server exception
|
||||
|
||||
Response parameters
|
||||
|
||||
parameter Data Type Description
|
||||
id String The device ID.
|
||||
mac String The device MAC address.
|
||||
sn String The group ID.
|
||||
serverId String The server ID.
|
||||
uniqueServerUrl String The server address.
|
||||
authName String The username for authentication.
|
||||
remark String The remark.
|
||||
|
||||
98 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/rps/devices HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"mac":"001565bbb1a9",
|
||||
"sn":"1106312113402006",
|
||||
"serverId":"ba7c7b13ed114a5fa6f12063ea9dff41",
|
||||
"remark":"SeakeerDevice",
|
||||
"authName":"Seakeer",
|
||||
"password":"654321"
|
||||
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 201 Created
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"id": "8d07a56207074d26b61026099625b9e2",
|
||||
"mac":"001565bbb1a9",
|
||||
"sn":"1106312113402006",
|
||||
"serverId":"ba7c7b13ed114a5fa6f12063ea9dff41",
|
||||
"remark":"SeakeerDevice",
|
||||
"authName":"Seakeer",
|
||||
|
||||
}
|
||||
|
||||
|
||||
5.1.2 Batch Add Devices
|
||||
Note: A maximum of 100 items at a time.
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/rps/addDevices
|
||||
Body parameter
|
||||
|
||||
99 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Parameter Data Requ Description
|
||||
Type ired
|
||||
mac String Yes Device MAC, minimum length 12, maximum
|
||||
length 17
|
||||
sn String Yes SN code, maximum length 128
|
||||
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
|
||||
|
||||
parameter Data Type Description
|
||||
mac String The device MAC address.
|
||||
|
||||
100 / 164
|
||||
@@ -0,0 +1,880 @@
|
||||
# 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
|
||||
@@ -0,0 +1,880 @@
|
||||
# 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
|
||||
@@ -0,0 +1,892 @@
|
||||
# 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
|
||||
@@ -0,0 +1,155 @@
|
||||
# Open API for Yealink Management Cloud Service V4X.pdf - Pages 161-164
|
||||
|
||||
**Source:** Open API for Yealink Management Cloud Service V4X.pdf
|
||||
**Pages:** 161-164 of 164
|
||||
**Chunk:** 9
|
||||
|
||||
---
|
||||
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"mac":"001565"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"total": 1,
|
||||
"data":[{
|
||||
"id": "01d7ae1897f7418dad2d26609329be38",
|
||||
"event":"Offline",
|
||||
"level":3,
|
||||
"mac":"001565bbb1a9",
|
||||
"model":"SIP-T54S",
|
||||
"ip":"10.50.198.156",
|
||||
"siteName":"test",
|
||||
"status":1,
|
||||
"firstAlarmTime":1737082468768
|
||||
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
13.Operation Log Management
|
||||
13.1 Operation Log List
|
||||
Request Method
|
||||
POST
|
||||
Request URL
|
||||
/v2/dm/listOpLogs
|
||||
Body parameter
|
||||
|
||||
Pa Da Re Description
|
||||
ra ta qu
|
||||
me Ty ir
|
||||
te p e
|
||||
161 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
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 Ye search parameters
|
||||
te te s
|
||||
r r
|
||||
|
||||
Filter object definition
|
||||
|
||||
parameter Data Type Required Description
|
||||
startTime Long No Start time
|
||||
endTime Long No End time
|
||||
|
||||
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 Log[] Log information array
|
||||
162 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
|
||||
Log object definition
|
||||
|
||||
parameter Data Type Description
|
||||
module String Log Module
|
||||
operationType String Log Type
|
||||
operationObject String Log Operation Object
|
||||
operator String Operator
|
||||
ip String IP
|
||||
createTime Long Time
|
||||
result String Result
|
||||
|
||||
Example Request
|
||||
|
||||
httpPOST /v2/dm/listOpLogs HTTP/1.1
|
||||
Host: api.ymcs.yealink.com
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"autoCount": true,
|
||||
"filter":{
|
||||
"startTime":1737099689158,
|
||||
"endTime":1738205662000
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Example Response
|
||||
|
||||
httpHTTP/1.1 200
|
||||
Content-Type: application/json;charset=UTF-8
|
||||
|
||||
{
|
||||
"skip": 0,
|
||||
"limit": 10,
|
||||
"total": 1,
|
||||
"data":[{
|
||||
"module":"i18n.yiot.backend.module.device.management",
|
||||
"operationTypetype":"i18n.yiot.backend.operation.device.management.restart",
|
||||
|
||||
163 / 164
|
||||
Open API for Yealink Management Cloud Service V4X
|
||||
|
||||
|
||||
"operationObject":"805ec0985cd2",
|
||||
"operator":"yiot123@yealink.com",
|
||||
"ip":"10.122.131.12",
|
||||
"createTime":"1736999161388",
|
||||
"result":"success"
|
||||
}]
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
164 / 164
|
||||
@@ -0,0 +1,431 @@
|
||||
# Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf - Pages 1-20
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf
|
||||
**Pages:** 1-20 of 84
|
||||
**Chunk:** 1
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Single Sign-On
|
||||
You can also log in via SSO , which is using your Microsoft account to easily log in
|
||||
to the YMCS platform, effectively improving login efficiency, and avoiding some
|
||||
of the security risks.
|
||||
|
||||
|
||||
|
||||
|
||||
1 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In with General Account
|
||||
Sign in with a reseller account
|
||||
Procedure
|
||||
1. For the first login, click the login address in the email or enter the login address (https://ymcs.yealink.com/
|
||||
reseller) in the browser address bar.
|
||||
2. Optional: Switch the language in the top-right corner.
|
||||
3. Enter your account and password and click Sign In.
|
||||
|
||||
💡 Note:
|
||||
If you are a first-time user, the system will prompt you to agree to the use of cookies, accept the
|
||||
privacy policy and terms of service, and update your password if necessary.
|
||||
If the login protection is enabled to enhance login security, you need to perform identity verification
|
||||
after logging in. For more information, refer to the login protection.
|
||||
|
||||
|
||||
|
||||
|
||||
Sign in with a support account
|
||||
Prerequisites
|
||||
You own a support account, and the support account has channel permissions.
|
||||
|
||||
2 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
About how to apply for an account with channel permissions, please refer to:
|
||||
FAQ.
|
||||
|
||||
Procedure
|
||||
1. For the first login, click the login address in the email or enter the login address (https://ymcs.yealink.com/
|
||||
reseller) in the browser address bar.
|
||||
2. Optional: Switch the language in the top-right corner.
|
||||
3. Click Support.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Enter your account and password and agree to the privacy policy.
|
||||
5. Click Login.
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Multiple Data Centers
|
||||
YMCS has three data centers, EU, US, and AU regions.
|
||||
The data between each region is isolated, meaning that data belonging to
|
||||
enterprises under the EU region will be stored in the EU region data center,
|
||||
while data belonging to enterprises under the US region will be stored in the US
|
||||
region data center.
|
||||
You can view and manage the enterprises and devices under different regions. For more information, see
|
||||
manage enterprise users.
|
||||
When creating enterprise users, you can select the belonging region for the enterprise account. And the
|
||||
enterprise data will be stored in the region you select. For more information, see add enterprise users.
|
||||
|
||||
|
||||
|
||||
|
||||
5 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Account Information
|
||||
Introduction
|
||||
|
||||
Click and go to the Account Settings page to view and edit the account
|
||||
information. You can also switch languages, view the privacy policy and terms of
|
||||
service, download documents, or sign out.
|
||||
|
||||
Edit the Login Password
|
||||
Introduction
|
||||
To ensure account security, we recommend that you change the password
|
||||
regularly.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
2. Click > Account Settings.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the Password field, click Edit.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. Enter the current password, the new password, and the confirm password.
|
||||
|
||||
💡 NOTE
|
||||
Password requirements:
|
||||
The password must be between 8 and 32 characters.
|
||||
The password must contain at least three of the following: numbers, lowercase and uppercase
|
||||
letters, and special characters.
|
||||
The password must only contain numbers, lowercase and uppercase letters, and special characters
|
||||
(excluding space).
|
||||
Password cannot contain account.
|
||||
The password cannot contain continuous or repeated more than 3 times characters.
|
||||
|
||||
|
||||
5. Click OK.
|
||||
6.
|
||||
|
||||
|
||||
|
||||
|
||||
7 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Contacts and Contact Number
|
||||
Introduction
|
||||
You can modify the contact person and contact phone number associated with
|
||||
your account, which is used to facilitate communication with your superiors.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
2. Click > Account Settings.
|
||||
3. In the Contact/Phone Number field, click Edit.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
8 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. When you finish editing, click Save.
|
||||
5.
|
||||
|
||||
|
||||
|
||||
|
||||
Trusted Devices
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
3. In the Trusted Devices section, click View.
|
||||
4. In the pop-up window, you can view all the devices where you have previously checked the "Skip re-
|
||||
verification within 30 days" option during login verification. You can remove devices, and the next time you
|
||||
|
||||
9 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
log in with those devices, you will need to undergo MFA verification again.
|
||||
|
||||
|
||||
|
||||
|
||||
10 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Configure Login Verification (Sub
|
||||
Account)
|
||||
Prerequisite
|
||||
The super administrator has enabled login protection for you. Otherwise, you cannot
|
||||
enable the login protection.
|
||||
Perform Login Verification
|
||||
|
||||
Introduction
|
||||
After the super administrator has enabled the login protection for you, you need
|
||||
to choose the login verification for the initial login. The selected verification
|
||||
method will serve as your subsequent login protection method.
|
||||
|
||||
|
||||
|
||||
|
||||
Perform Email Verification
|
||||
If you select email verification during the initial login, it will serve as your
|
||||
subsequent login protection method.
|
||||
Procedure
|
||||
1. Select Email, and enter the dynamic code in the mail you received.
|
||||
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will
|
||||
11 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
not need to undergo verification when logging in to this account using the
|
||||
same device within 30 days.
|
||||
2. Click OK.
|
||||
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
Perform Virtual MFA Verification
|
||||
Procedure
|
||||
1. Select Virtual MFA Device.
|
||||
|
||||
2. Download and open Google Authenticator on your phone and click Get
|
||||
|
||||
started.
|
||||
3. Sign in to a Google account.
|
||||
|
||||
|
||||
💡 TIP
|
||||
After you sign in to a Google account, you can back up the verification codes to your Google
|
||||
account for easy retrieval. To avoid situations where verification codes cannot be retrieved
|
||||
after Google Authenticator is uninstalled or data is cleared, it is recommended that you do not
|
||||
skip the login steps.
|
||||
|
||||
|
||||
4. Do one of the following:
|
||||
|
||||
Select Scan a QR code in Google Authenticator and scan the QR code in the
|
||||
pop-up window on the YMCS portal.
|
||||
12 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Select Enter a setup key on Google Authenticator, then enter the YMCS
|
||||
account and the key displayed in the pop-up window, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
13 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
5. The dynamic code will be displayed in Google Authenticator.
|
||||
|
||||
6. Enter the dynamic code into the corresponding area of YMCS.
|
||||
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will
|
||||
not need to undergo verification when logging in to this account using the
|
||||
same device within 30 days.
|
||||
7. Click OK.
|
||||
|
||||
8.
|
||||
|
||||
|
||||
14 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Change Login Protection Methods
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
2. Click > Account Settings.
|
||||
3. In the Login Protection field, click Edit.
|
||||
|
||||
4. Do one of the following to select the desired login protection method:
|
||||
|
||||
Select Email, enter the dynamic code in the mail you received, and click OK.
|
||||
|
||||
i. Select Virtual MFA Device.
|
||||
|
||||
ii. Install and open Google Authenticator on the mobile side, and click Get
|
||||
|
||||
started.
|
||||
|
||||
|
||||
|
||||
|
||||
15 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
iii.
|
||||
|
||||
|
||||
16 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
iii. Sign in to a Google account.
|
||||
|
||||
|
||||
💡 Tip:
|
||||
After you sign in to a Google account, you can back up the verification codes to your Google
|
||||
account for easy retrieval. To avoid situations where verification codes cannot be retrieved
|
||||
after Google Authenticator is uninstalled or data is cleared, it is recommended that you do not
|
||||
skip the login steps.
|
||||
|
||||
|
||||
iv. Do one of the following:
|
||||
|
||||
Select Scan a QR code in Google Authenticator and scan the QR code in
|
||||
the pop-up window on the YMCS portal.
|
||||
|
||||
|
||||
|
||||
|
||||
17 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Select Enter a setup key on Google Authenticator, then enter the YMCS
|
||||
account and the key displayed in the pop-up window, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
18 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
v. The dynamic code is displayed in Google Authenticator.
|
||||
|
||||
vi. Enter the dynamic code into YMCS and click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
19 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Configure Login Verification (Super
|
||||
Administrator)
|
||||
Introduction
|
||||
For single-factor authentication, the passwords are easily cracked by brute
|
||||
force. To solve that, YMCS supports multi-factor authentication (MFA), requiring
|
||||
users to pass two authentications before they can sign in to YMCS. By enabling
|
||||
login protection, you will need to authenticate through both password and
|
||||
dynamic verification code to gain authorization and sign in to YMCS.
|
||||
Email Verification
|
||||
Enable Email Verification
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
2. Click > Account Settings.
|
||||
3. In the Login Protection field, click Edit.
|
||||
4. Select Email, enter the dynamic code in the mail you received, and click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
5.
|
||||
|
||||
Sign In with Email Verification
|
||||
After enabling it, users will receive a verification email after entering their
|
||||
account and password to log in. Enter the verification code in the corresponding
|
||||
area to complete the login process.
|
||||
Procedure
|
||||
1. After clicking Sign In, enter the verification code received in your email in the corresponding area.
|
||||
20 / 41
|
||||
@@ -0,0 +1,484 @@
|
||||
# Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf - Pages 21-40
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf
|
||||
**Pages:** 21-40 of 84
|
||||
**Chunk:** 2
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will not need to undergo verification
|
||||
when logging in to this account using the same device within 30 days.
|
||||
2. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
MFA Verification
|
||||
Enable MFA Verification
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
2. Click > Account Settings.
|
||||
3. In the Login Protection field, click Edit.
|
||||
4. Select Virtual MFA Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5.
|
||||
|
||||
21 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
5. Hover over Check how to get the dynamic code and do the following to get the dynamic code.
|
||||
6. Install and open Google Authenticator on the mobile side, and click Get started.
|
||||
7. Sign in to a Google account.
|
||||
|
||||
💡 TIP
|
||||
After you sign in to a Google account, you can back up the verification codes to your Google
|
||||
account for easy retrieval. To avoid situations where verification codes cannot be retrieved
|
||||
after Google Authenticator is uninstalled or data is cleared, it is recommended that you do not
|
||||
skip the login steps.
|
||||
|
||||
8. Do one of the following:
|
||||
Select Scan a QR code in Google Authenticator and scan the QR code in the pop-up window on the YMCS
|
||||
portal.
|
||||
|
||||
|
||||
|
||||
|
||||
22 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Select Enter a setup key on Google Authenticator, then enter the YMCS account and the key displayed in
|
||||
the pop-up window, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
23 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
9. The dynamic code is displayed in Google Authenticator.
|
||||
10. Enter the dynamic code into YMCS and click OK.
|
||||
11.
|
||||
|
||||
|
||||
|
||||
|
||||
24 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In with MFA Verification
|
||||
After enabling it, users will be required to enter the dynamic code obtained from
|
||||
Google Authenticator after entering their account and password to complete the
|
||||
login process.
|
||||
Procedure
|
||||
1. After clicking Sign In, enter the dynamic code into the corresponding area of YMCS.
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will not need to undergo verification
|
||||
when logging in to this account using the same device within 30 days.
|
||||
2. Click OK.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
25 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Channel Users
|
||||
Add Channel Accounts
|
||||
|
||||
Introduction
|
||||
You can add sub-channels, and the sub-channels can add their sub-channels.
|
||||
You can also control whether your sub-channel can add their sub-channels.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click User Management > Channel Management > Add.
|
||||
3. Configure channel information and click OK.
|
||||
Channel Name: Enter the channel name.
|
||||
Set Administrator:
|
||||
If you choose to set it as an administrator, you need to enter an email address, and the sub-channel can
|
||||
log in using this email address.
|
||||
If you do not, an email address is not required, and you can manage the sub-channels on their behalf.
|
||||
Country/Region: Select the country or region where this channel account is located.
|
||||
Time Zone: Select a time zone.
|
||||
Contact: Enter a contact.
|
||||
Phone Number: Enter a contact phone number.
|
||||
Add Sub-Channel: If you select Enable in the Add Sub-Channel field, the sub-channel can add and
|
||||
manage their sub-channels (add channel, edit channel information, etc.).
|
||||
|
||||
|
||||
|
||||
|
||||
27 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Confirm in the pop-up window to add the channel successfully.
|
||||
|
||||
|
||||
28 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Channels
|
||||
|
||||
View the Channel List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click User Management > Channel Management.
|
||||
3. View the channel name, status and other information in the channel list.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In to YMCS on Behalf of Channel Accounts
|
||||
Procedure
|
||||
1. In the channel list, click Manage on the right side of the channel account.
|
||||
|
||||
💡 Note
|
||||
This feature is unavailable to frozen or unauthorized channels.
|
||||
|
||||
|
||||
Edit Channel Account
|
||||
Procedure
|
||||
1. In the channel list, click > Edit.
|
||||
|
||||
Reset Password for Channel Account
|
||||
Introduction
|
||||
|
||||
29 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
You can reset the password to deal with password leakage and manage
|
||||
personnel changes to enhance security.
|
||||
Procedure
|
||||
1. In the channel list, click > Reset Password.
|
||||
|
||||
Freeze Channel Account
|
||||
Introduction
|
||||
You can efficiently deal with situations such as service expiration by freezing
|
||||
channels. After the channel account is frozen, the channel cannot use the
|
||||
account to log in to YMCS for Channel.
|
||||
Procedure
|
||||
1. In the channel list, click > Freeze.
|
||||
2. Enter the freezing reason in the pop-up window and click OK.
|
||||
|
||||
Unfreeze Channel Account
|
||||
Introduction
|
||||
You can unfreeze the frozen channel. After unfreezing, the channel can log in to
|
||||
YMCS for channel again.
|
||||
Procedure
|
||||
1. In the channel list, click > Unfreeze.
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Enterprise Users
|
||||
Add Enterprise Accounts
|
||||
|
||||
Introduction
|
||||
You can add enterprise accounts and edit the enterprise information. When an
|
||||
exception occurs to the enterprise, you can freeze the enterprise account. From
|
||||
the channel platform, you can log in to YMCS for enterprise or YMCS for RPS
|
||||
enterprise to manage devices for enterprises. For more information on how to
|
||||
manage devices on YMCS for enterprise, see the YMCS for enterprise user guide.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click User Management > Enterprise Management > Enterprise List > Add.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the information of the enterprise account.
|
||||
Data Center: The data center is divided into EU, US, and AU regions. The data between the regions is
|
||||
isolated, meaning that data belonging to companies under the EU region will be stored in the EU region
|
||||
data center, while data belonging to companies under the US region will be stored in the US region data
|
||||
center. Please select the data center according to the actual location of the enterprise.
|
||||
Enterprise Name: Enter the name of the enterprise.
|
||||
Permission: Assign permissions to the enterprise account. Device Management (RPS): The enterprise
|
||||
account can log in to YMCS to use device management and RPS features. RPS: The enterprise account can
|
||||
log in to YMCS but can only use the RPS feature.
|
||||
|
||||
31 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
Set Administrator:
|
||||
If you select Yes, enter an email address, and this enterprise account can use the email to log in to YMCS.
|
||||
If you select No, an email address is not required, and you can use this channel account to manage
|
||||
devices for the enterprise account.
|
||||
Email: Enter the email address of this enterprise account. The account information will be sent by email.
|
||||
Enterprise Info: Set the following information, including country/region, time zone, contact person,
|
||||
contact number, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
32 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click OK.
|
||||
|
||||
💡 Note：
|
||||
Please confirm the enterprise information and the data center you select. It cannot be
|
||||
modified after saving.
|
||||
33 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
5. Click Confirm in the pop-up window to successfully add the enterprise.
|
||||
|
||||
💡 Note：
|
||||
When the enterprise administrator logs in to YMCS for the first time, the page will prompt
|
||||
whether to allow authorization to the channel, and the enterprise administrator can accept or
|
||||
reject it.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Enterprises
|
||||
|
||||
View the Enterprise List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click User Management > Enterprise Management > Enterprise List.
|
||||
3. View the enterprise name, the permission, the status and other information in the enterprise list.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In to YMCS on Behalf of Enterprise Accounts
|
||||
Introduction
|
||||
You can log in to YMCS for Enterprise with enterprise authorization to manage
|
||||
devices or perform other operations on their behalf.
|
||||
Prerequisites
|
||||
34 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
The enterprise has authorized the management to you.
|
||||
Procedure
|
||||
1. In the enterprise list, click Manage on the right side of the enterprise account to go to YMCS for Enterprise.
|
||||
|
||||
Edit Enterprise Account Information
|
||||
Procedure
|
||||
1. In the enterprise list, click > Edit.
|
||||
|
||||
Reset Password for Enterprise Account
|
||||
Introduction
|
||||
You can reset the password to deal with password leakage and manage
|
||||
personnel changes to enhance security.
|
||||
Procedure
|
||||
1. In the enterprise list, click > Reset Password.
|
||||
|
||||
💡 Note：
|
||||
Password reset is unavailable to non-mailbox enterprises.
|
||||
|
||||
|
||||
Freeze Enterprise Account
|
||||
Introduction
|
||||
You can efficiently deal with situations such as service expiration by freezing
|
||||
businesses. After the enterprise account is frozen, the enterprise cannot use the
|
||||
account to log in to YMCS for Enterprise or RPS Enterprise.
|
||||
Procedure
|
||||
1. In the enterprise list, click > Freeze.
|
||||
2. Enter the freezing reason in the pop-up window and click OK.
|
||||
|
||||
Unfreeze Enterprise Account
|
||||
Introduction
|
||||
You can unfreeze the frozen enterprise. After unfreezing, the enterprise can log
|
||||
in to YMCS for Enterprise.
|
||||
Procedure
|
||||
1. In the enterprise list, click > Unfreeze.
|
||||
|
||||
|
||||
|
||||
|
||||
35 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
Manage Enterprise Authorization
|
||||
|
||||
Introduction
|
||||
The enterprises you create can choose whether to authorize the management to
|
||||
you when they log in to YMCS for the first time.
|
||||
If the enterprise initially created by you rejects authorizing the management to
|
||||
you, they also need to use an authorization code to apply for management by
|
||||
you.
|
||||
You can manage enterprises not created by you through an authorized code
|
||||
application, and you can approve or reject the application.
|
||||
|
||||
Channel Authorization Code
|
||||
Introduction
|
||||
You can send the authorization code to the enterprise that needs to be managed
|
||||
and manage it after the enterprise is authorized.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click User Management > Enterprise Management > Enterprise Authorization.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
Click to copy the authorization code and send it to the enterprise to be managed.
|
||||
Click to refresh the authorization code.
|
||||
|
||||
Approve/Reject Authorization Application
|
||||
Introduction
|
||||
36 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
You can view the list of enterprises that have requested you to manage their
|
||||
devices on their behalf. You can approve or reject the applications.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click User Management > Enterprise Management > Enterprise Authorization.
|
||||
3. Do one of the following:
|
||||
Click Agree/Reject on the right side of the enterprise.
|
||||
Select multiple enterprises and click Agree/Reject.
|
||||
|
||||
|
||||
|
||||
|
||||
37 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Devices
|
||||
Manage Room Devices
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > Room Device.
|
||||
3. Click EU Region/US Region/AU Region in the top-right corner to view the devices belonging to the selected
|
||||
region.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
4. On the right side of the device, click Manage to go to the room device list of the corresponding enterprise.
|
||||
|
||||
💡 NOTE
|
||||
This feature is unavailable to frozen enterprises.
|
||||
|
||||
5. Manage the device. For more information, refer to YMCS for enterprise user guide - manage room devices.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage USB Devices
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > USB Device.
|
||||
3. Click EU Region/US Region/AU Region in the top-right corner to view the devices belonging to the selected
|
||||
|
||||
38 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
region.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
4. On the right side of the device, click Manage to go to the USB device list of the corresponding enterprise.
|
||||
|
||||
💡 NOTE
|
||||
This feature is unavailable to frozen enterprises.
|
||||
|
||||
5. Manage the device. For more information, refer to YMCS for enterprise user guide - manage USB devices.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage RPS Devices
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > RPS Device.
|
||||
3. Click EU Region/US Region/AU Region in the top-right corner to view the devices belonging to the selected
|
||||
region.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
39 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. On the right side of the device, click Manage to go to the RPS device list of the corresponding enterprise.
|
||||
|
||||
💡 NOTE
|
||||
This feature is unavailable to frozen enterprises.
|
||||
|
||||
5. Perform RPS device management. For more information, refer to YMCS for enterprise user guide - manage RPS
|
||||
devices.
|
||||
|
||||
|
||||
|
||||
|
||||
40 / 41
|
||||
@@ -0,0 +1,472 @@
|
||||
# Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf - Pages 41-60
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf
|
||||
**Pages:** 41-60 of 84
|
||||
**Chunk:** 3
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
View Device List
|
||||
Introduction
|
||||
You can view and manage the devices of authorized enterprises, including
|
||||
phone devices, room devices, USB devices and RPS devices.
|
||||
|
||||
Prerequisites
|
||||
You can only view and manage the devices of authorized enterprises.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > Phone Device/Room Device/USB Device/RPS Device.
|
||||
View the device list.
|
||||
|
||||
💡 TIP
|
||||
You can click EU Region/US Region/AU Region in the top-right corner to view the devices
|
||||
belonging to the selected region.
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 41
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Monitor Wall
|
||||
Introduction
|
||||
By viewing the monitor wall, you can have a comprehensive and real-time grasp
|
||||
of various data and conditions of the device of each enterprise without the need
|
||||
for frequent manual refreshes.
|
||||
Prerequisites
|
||||
Please contact and provide the email of your account to the Yealink Support in order to enable this feature.
|
||||
Only super admin can use this feature, normal users can obtain a link from the super admin and enter the link
|
||||
to view the monitor wall.
|
||||
Only support viewing the device status within the enterprises authorized and managed by your channel.
|
||||
|
||||
View the Monitor Wall
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
|
||||
💡 NOTE
|
||||
Only the device status within the enterprises authorized and managed by
|
||||
your channel can be displayed.
|
||||
|
||||
1. Hover the mouse over the thumbnail of the monitor wall and click Preview.
|
||||
|
||||
|
||||
|
||||
|
||||
1 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
2. View various indicators of the device in real time on the monitor wall.
|
||||
|
||||
|
||||
|
||||
|
||||
Numbe Description
|
||||
r
|
||||
1 Current time.
|
||||
2 The total number of enterprises and the number of enterprises
|
||||
authorized to be managed.
|
||||
3 Device statistics. Count the number of various types of device.
|
||||
4 Device status. Count the total number of devices and the number
|
||||
and proportion of online/offline/pending devices.
|
||||
5 Model statistics. Count different types of device and their
|
||||
quantities.
|
||||
6 Displays the number of new alarms today.
|
||||
7 Active alarm records. Count the enterprises with the largest
|
||||
number of active alarms and their detailed information, including:
|
||||
alarm type, company name, device name, model, and last alarm
|
||||
time.
|
||||
8 The number of new alarms in the past 7 days. Statistics of the
|
||||
number and severity of daily alarms in the past 7 days.
|
||||
|
||||
2 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
9 Top 5 Active Alarm Enterprises. Count the enterprises with the
|
||||
largest number of active alarms.
|
||||
10 Top 5 Offline Devices Enterprises. Count the enterprises with the
|
||||
largest number of offline devices.
|
||||
11 Top 5 Active Alarm Types. Count the 5 largest existing alarm types.
|
||||
|
||||
Set the Monitor Wall
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Click > Settings in the lower right corner of the thumbnail of the monitor wall.
|
||||
|
||||
|
||||
|
||||
|
||||
Data Refresh Period: Set the time for automatic refresh of the monitor wall. It will be updated with real-
|
||||
time data at that frequency.
|
||||
Access Whitelist: If not enabled, devices under any IP can access the monitor wall through links; if enabled,
|
||||
only IP addresses in the whitelist can access.
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Copy the Link of the Monitor Wall
|
||||
You can obtain the link of the monitor wall, which can be accessed by users in
|
||||
the IP whitelist. They can view the specific content of the monitor wall, or
|
||||
display it as material/content on Yealink Digital Signage or Third Party Digital Signage.
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Click > Copy Link in the lower right corner of the thumbnail of the monitor wall.
|
||||
4. Make relevant settings, click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
5 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Room Device Calculator
|
||||
Introduction
|
||||
You can use Yealink Room Device Calculator to create room projects and
|
||||
manage them by group.
|
||||
Procedure
|
||||
Create a room project on Room Device Calculator
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device Calculator > Create.
|
||||
3. About how to use the tool, please refer to: Yealink Room Device Calculator.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage room projects by group
|
||||
1. In the Room Device Calculator page, click Save.
|
||||
2. Select a group or create a new group in the pop-up window, click Confirm.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following to manage room projects by group:
|
||||
|
||||
In the Room Device Calculator page, click > My Files.
|
||||
|
||||
|
||||
|
||||
|
||||
Enter the Room Device Calculator page of YMCS. All the grouping-related operations you perform on the
|
||||
Room Device Calculator will be synchronized here.
|
||||
4. Do one of the following:
|
||||
|
||||
💡 NOTE
|
||||
Deleting the group will delete the files in the group as well.
|
||||
|
||||
7 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
In the Group catalog, click to add new group.
|
||||
|
||||
In the Group catalog, click > Rename on the right side of the group, renane the group.
|
||||
|
||||
In the Group catalog, click > Delete on the right side of the group, delete the group.
|
||||
In the file list, you can perform Edit, Move, Download and other operations.
|
||||
|
||||
|
||||
|
||||
|
||||
8 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Login Management
|
||||
Login Whitelist
|
||||
IP Whitelist
|
||||
Introduction
|
||||
Support editing login whitelist, only IP addresses within the whitelist can log in
|
||||
to the enterprise management platform, which further enhance the enterprise
|
||||
security.
|
||||
|
||||
💡 Note： Whether the channel end can access the enterprise management
|
||||
platform is not restricted by the login whitelist.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Login Mangement > Login Whitelist.
|
||||
|
||||
3. Click to add and edit the login whitelist, you can add a maximum of 20 IP addresses.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
9 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click to enable IP Whitelist.
|
||||
|
||||
|
||||
|
||||
|
||||
Password Change Reminder
|
||||
Introduction
|
||||
You can set a password change reminder and the frequency of the reminder. If
|
||||
an administrator's password exceeds the set frequency, they will receive an
|
||||
10 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
email reminder to change their password.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Login Mangement > Login Whitelist.
|
||||
|
||||
3. In the Password Change Reminder section, click to enable it.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the reminder frequency and save.
|
||||
|
||||
💡 Note：
|
||||
The maximum setting is 365 days.
|
||||
|
||||
|
||||
|
||||
|
||||
11 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Single Sign-On
|
||||
Step 1 Configure Microsoft Azure AD Login Method
|
||||
|
||||
Procedure
|
||||
1. Log in to the Azure admin portal.
|
||||
|
||||
2. Click > Microsoft Entra ID in the top-left corner.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
12 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Enterprise applications in the left navigation bar.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Manage > Enterprise applications > New application.
|
||||
5.
|
||||
|
||||
|
||||
|
||||
|
||||
13 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Create your own application. Enter the application name and check Register an application to
|
||||
integrate with Microsoft Entra ID(App you’re deploying) and click Create.
|
||||
6.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Check Accounts in this organizational directory only (yealinkwmtest only - Single tenant) to support trial
|
||||
for users in the current tenant directory and click Register.
|
||||
|
||||
14 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
7.
|
||||
|
||||
|
||||
|
||||
|
||||
7. Go back to the Microsoft Entra ID page, click Manage > App registrations, find and click the application you
|
||||
just created.
|
||||
8.
|
||||
|
||||
|
||||
|
||||
|
||||
8. Go to the application details page. The Application (client) ID is the Client ID and the directory (tenant) is the
|
||||
|
||||
15 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
Tenant ID.
|
||||
|
||||
|
||||
|
||||
|
||||
9. Click Manage > Authentication > Add a platform in the left navigation bar and select Web.
|
||||
10.
|
||||
|
||||
|
||||
|
||||
|
||||
10. Enter the login address in the Redirect URIs field, the logout address in the Front-channel logout URL field,
|
||||
|
||||
16 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
and select the check box of ID tokens (used for implicit and hybrid flows) and click Configure. Please
|
||||
enter the following login and logout addresses.
|
||||
Login address: https://reseller.ymcs.yealink.com/reseller/front/auth/signin-oidc
|
||||
Logout address: https://reseller.ymcs.yealink.com/reseller/front/auth/logout
|
||||
|
||||
|
||||
|
||||
|
||||
11. The configuration is complete. You can perform further SSO configuration in the YMCS platform.
|
||||
|
||||
|
||||
|
||||
|
||||
Step 2 Enable and Configure SSO
|
||||
|
||||
Introduction
|
||||
After enabling single sign-on and creating third-party administrator accounts,
|
||||
you can use these accounts to sign in to the YMCS platform with the account and
|
||||
password of the third-party platform (only Microsoft accounts are supported),
|
||||
improving login efficiency and avoiding security risks.
|
||||
Procedure
|
||||
Enable SSO
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Login Management > Single Sign-On.
|
||||
3. Click the toggle beside Single Sign-On to enable it.
|
||||
4. Select an authentication platform (currently, only Microsoft Azure AD is supported).
|
||||
17 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
5. Refer to the Microsoft AD login configuration method and enter the Client ID of Microsoft Azure AD as well as
|
||||
the Tenant ID to configure the authentication platform.
|
||||
6. Click Save.
|
||||
|
||||
Create a Sub Account with SSO Feature
|
||||
Please refer to add sub accounts to create a sub account with SSO feature.
|
||||
Once configured, this sub account can log in to the YMCS platform using SSO.
|
||||
|
||||
|
||||
|
||||
Step 3 Sign In via SSO
|
||||
|
||||
Introduction
|
||||
You can use your Microsoft account to easily log in to the YMCS platform,
|
||||
effectively improving login efficiency and avoiding some of the security risks.
|
||||
Prerequisites
|
||||
Your channel has configure Microsoft Azure AD login method and enabled SSO.
|
||||
The channel administrator has created a third-party administrator account for you.
|
||||
|
||||
Procedure
|
||||
1. For the first login, click the login address in the email or enter the login address in the browser address bar.
|
||||
|
||||
💡 Tip: You can use the global address (https://ymcs.yealink.com/manager/
|
||||
login) to sign in, and YMCS will automatically detect and redirect you to
|
||||
your region.
|
||||
|
||||
2. Optional: Switch the language in the top-right corner.
|
||||
3. Click SSO.
|
||||
4. Enter the third-party account and click Continue.
|
||||
5. On the Microsoft login authentication page, enter your Microsoft account and password. After finishing the
|
||||
verification, you can log in to YMCS.
|
||||
|
||||
|
||||
|
||||
|
||||
18 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Sub Accounts and Their
|
||||
Permission
|
||||
Roles
|
||||
Add Roles
|
||||
|
||||
Introduction
|
||||
The default role and its permission are described below:
|
||||
|
||||
Name Description
|
||||
Super Have all the function permission under the device management,
|
||||
admin RPS management,
|
||||
No Only the permission to log in.
|
||||
permissi
|
||||
on
|
||||
|
||||
In addition to the default roles, you can add other roles and assign the
|
||||
corresponding permission to the role.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Sub Accounts > Role.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
19 / 43
|
||||
@@ -0,0 +1,490 @@
|
||||
# Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf - Pages 61-80
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf
|
||||
**Pages:** 61-80 of 84
|
||||
**Chunk:** 4
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
Select a group from the group list on the left panel and click Add. You can also click Add Group if you do
|
||||
not want to specify a group.
|
||||
|
||||
|
||||
|
||||
|
||||
Click on the right side of the group and click Add Role.
|
||||
|
||||
|
||||
|
||||
|
||||
20 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the role information and click Save.
|
||||
Role Name: Edit the role name.
|
||||
Group: Select a belonging group for this role for future management.
|
||||
Description: Enter a description.
|
||||
Data Permission-Channel: Edit data permissions for this role to only view and manage channel data
|
||||
within the specified scope.
|
||||
Data Permission-Enterprise: Edit data permissions for this role to only view and manage enterprise and
|
||||
related device records within the specified scope.
|
||||
Permission: Assign management permissions for all functions in User Management, Device Management,
|
||||
System Settings to the role.
|
||||
Read Only: Can only browse and cannot perform related operations.
|
||||
Read & Write: Can browse and perform related operations.
|
||||
All Invisible: The functionality module will not be displayed to them.
|
||||
|
||||
|
||||
|
||||
|
||||
21 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Roles
|
||||
|
||||
Go to the Role List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Sub Accounts > Role.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
22 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
Add Groups
|
||||
Introduction
|
||||
You can add groups and manage the roles by group.
|
||||
Procedure
|
||||
1. Do one of the following:
|
||||
In the role list, click Add Group.
|
||||
|
||||
|
||||
|
||||
|
||||
In the group list, click > Add Group on the right side of All.
|
||||
|
||||
|
||||
|
||||
|
||||
23 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
2. Enter the group name and click Confirm.
|
||||
|
||||
|
||||
|
||||
|
||||
3. After adding a group, you can find the group from the group list.
|
||||
|
||||
Manage Roles by Group
|
||||
Introduction
|
||||
You can organize and manage administrators within the enterprise by grouping
|
||||
them. Each role can only belong to one group.
|
||||
Procedure
|
||||
1. In the role list, click the desired group.
|
||||
2. Do one of the following:
|
||||
Check the corresponding role information within this group.
|
||||
|
||||
|
||||
|
||||
|
||||
24 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Click on the right side of the group to edit groups, add roles to the group, and delete groups.
|
||||
|
||||
|
||||
|
||||
|
||||
View Sub Accounts Associated with a Role
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
2. Click Sub Accounts.
|
||||
3. View the sub accounts associated with this role. Those sub accounts have all the permissions assigned to this
|
||||
role.
|
||||
|
||||
25 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Assign a Role to a Sub Account
|
||||
For more information, please refer to: Assign a Role to a Sub Account.
|
||||
|
||||
Edit Role Permission
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
2. Click Permission.
|
||||
3. Edit the role permission and click Save.
|
||||
|
||||
💡 Note
|
||||
You cannot edit the permission of the default role (super admin/no permission).
|
||||
|
||||
|
||||
|
||||
|
||||
Sub Accounts
|
||||
Add Sub Accounts
|
||||
|
||||
Introduction
|
||||
According to the actual needs, you can add sub-accounts and give them
|
||||
different function and data permission (data permission are divided based on
|
||||
the scope of enterprises/channels that the account will manage), so as to
|
||||
|
||||
26 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
achieve efficient and convenient permission allocation. After that, you can also
|
||||
use the sub account to log in to YMCS for channel.
|
||||
Procedure
|
||||
Add sub-accounts manually
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Sub Accounts > Sub Accounts > Add Sub Account.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure the corresponding information.
|
||||
|
||||
💡 Note：You need to configure Single Sign-On (SSO)first to be able to select a third-party
|
||||
account.
|
||||
|
||||
Account Type : Select Ordinary / External.
|
||||
Edit the registration email, contact person, contact phone, description, and select whether to enable login
|
||||
protection for this account.
|
||||
|
||||
💡 Note：If you enable login protection for a sub-account, the sub-account will need to choose
|
||||
between email verification or virtual MFA verification as the login verification method during
|
||||
the first login. For more information, please refer to Login Verification.
|
||||
|
||||
|
||||
|
||||
|
||||
27 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Invite sub-accounts using an invitation link
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Sub Accounts > Sub Accounts > Invite Members.
|
||||
|
||||
|
||||
3. Click to copy the invitation link and send it to the corresponding user.
|
||||
|
||||
💡 TIP
|
||||
|
||||
Click to regenerate the invitation link. The original link will become
|
||||
invalid.
|
||||
You can set an expiration date for the invitation link.
|
||||
You can enable Joining requires moderation . If enabled, you need to
|
||||
click Go to audit to approve/reject/delete the application in the review
|
||||
list. If disabled, users can join directly through the invitation link
|
||||
without requiring approval.
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. In the sub-account list, find the user and click on the Edit button on the right
|
||||
side to configure the relevant information.
|
||||
|
||||
|
||||
|
||||
Manage Sub Accounts
|
||||
|
||||
Access the Sub Account List
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Sub Accounts > Sub Accounts.
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
Edit Sub Account Information
|
||||
1. In the sub account list, click Edit to edit sub account information.
|
||||
|
||||
Enable/Disable Login Protection
|
||||
1. Do one of the following:
|
||||
|
||||
In the sub account list, click and select Enable/Disable Login Protection.
|
||||
In the sub account list, select the desired sub accounts and select Enable/Disable Login Protection.
|
||||
|
||||
Reset Password
|
||||
You can reset the password to deal with password leakage and manage
|
||||
personnel changes to enhance security.
|
||||
1. In the sub account list, click > Reset password and confirm the action.
|
||||
|
||||
Disable/Enable the Sub Account
|
||||
The sub account is enabled by default. You can enable/disable the sub account.
|
||||
When its account status changes, the sub account will receive an email
|
||||
notification.
|
||||
1. Do one of the following:
|
||||
|
||||
In the sub account list, click > Disable. This sub account cannot be used to log in to YMCS.
|
||||
|
||||
In the sub account list, click > Enable. This sub account can use this account to log in to YMCS.
|
||||
|
||||
Delete Sub Accounts
|
||||
1. In the sub account list, click > Delete and confirm the action.
|
||||
|
||||
|
||||
|
||||
|
||||
Assign a Role to a Sub Account
|
||||
Introduction
|
||||
The allocation of function permissions is achieved by associating sub-accounts
|
||||
with roles.
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click System Settings > Sub Accounts.
|
||||
3. Do one of the following:
|
||||
On the Sub Accounts page, add a sub account.
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
On the Role page, add a role.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Perform one of the following operations:
|
||||
On the Sub Accounts page, click Edit on the right side of the sub-administrator and select the
|
||||
corresponding role.
|
||||
|
||||
|
||||
|
||||
|
||||
31 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
On the Role page, click Add on the right side of the role and select the corresponding role.
|
||||
|
||||
|
||||
|
||||
|
||||
32 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Logs
|
||||
Introduction
|
||||
Log management records all operation records on the channel side. You can
|
||||
view the operation information, including modules, types, objects, operators,
|
||||
IPs, results and time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
2. Click System Settings > Log Management.
|
||||
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
3. View all operation logs.
|
||||
|
||||
You can view the operation log for a period of time by selecting the time
|
||||
range.
|
||||
You can enter the operator/IP in the search box to match the corresponding
|
||||
operation log.
|
||||
|
||||
|
||||
|
||||
|
||||
33 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
34 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Alarms
|
||||
Introduction
|
||||
When a problem occurs to the device, for example, the call failure or firmware
|
||||
update failure will be reported to YMCS. You can quickly locate the problem by
|
||||
viewing the alarm details and diagnosing the devices.
|
||||
Prerequisites
|
||||
You can only manage authorized enterprises. For detailed information, please
|
||||
refer to Manage Enterprise Authorization.
|
||||
|
||||
Go to Alarm List
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Alarm.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
Add an Alarm
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Alarm > Add.
|
||||
3. Set the alarm configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
35 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Save.
|
||||
|
||||
Go to the Enterprise Corresponding to the Alarm
|
||||
1. Click Manage to quickly enter the enterprise corresponding to the alarm.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit an Alarm
|
||||
1. Click > Edit.
|
||||
|
||||
|
||||
|
||||
|
||||
Delete an Alarm
|
||||
1. Click > Delete.
|
||||
36 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
37 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Un-migrated Enterprise
|
||||
Accounts
|
||||
Introduction
|
||||
For enterprises you previously created, they can still use the YMCS-Legacy
|
||||
Edition (Legacy YMCS), and you can manage these enterprises on the new YMCS.
|
||||
At the same time, we recommend that you assist your enterprise acccounts in
|
||||
migrating to the new platform for easier management in the future.
|
||||
|
||||
💡 Note：Editing the information of un-migrated enterprise accounts is not
|
||||
available.
|
||||
|
||||
View the Un-migrated Enterprise List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Enterprise Management under the YMCS-Legacy Edition module.
|
||||
3.
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In to YMCS on Behalf of Enterprise Accounts
|
||||
Introduction
|
||||
38 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
You can log in to YMCS for Enterprise with enterprise authorization to manage
|
||||
devices or perform other operations on their behalf.
|
||||
Prerequisites
|
||||
The enterprise has authorized the management to you.
|
||||
Procedure
|
||||
1. In the enterprise list, click Manage enterprise on the right side of the enterprise account to go to YMCS for
|
||||
Enterprise.
|
||||
|
||||
Reset Password for Enterprise Account
|
||||
Introduction
|
||||
You can reset the password to deal with password leakage and manage
|
||||
personnel changes to enhance security.
|
||||
Procedure
|
||||
1. In the enterprise list, click > Reset Password.
|
||||
|
||||
💡 Note：Password reset is unavailable to non-mailbox enterprises.
|
||||
|
||||
|
||||
Freeze Enterprise Account
|
||||
Introduction
|
||||
You can efficiently deal with situations such as service expiration by freezing
|
||||
businesses. After the enterprise account is frozen, the enterprise cannot use the
|
||||
account to log in to YMCS for Enterprise or RPS Enterprise.
|
||||
Procedure
|
||||
1. In the enterprise list, click > Freeze.
|
||||
2. Enter the freezing reason in the pop-up window and click OK.
|
||||
|
||||
Unfreeze Enterprise Account
|
||||
Introduction
|
||||
You can unfreeze the frozen enterprise. After unfreezing, the enterprise can log
|
||||
in to YMCS for Enterprise.
|
||||
Procedure
|
||||
1. In the enterprise list, click > Unfreeze.
|
||||
|
||||
|
||||
|
||||
|
||||
39 / 43
|
||||
@@ -0,0 +1,84 @@
|
||||
# Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf - Pages 81-84
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf
|
||||
**Pages:** 81-84 of 84
|
||||
**Chunk:** 5
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Un-migrated Devices
|
||||
Introduction
|
||||
For enterprises you previously created, they can still use the YMCS-Legacy
|
||||
Edition (Classic YMCS), and you can manage these enterprises on the new YMCS.
|
||||
At the same time, we recommend that you assist your enterprise accounts in
|
||||
migrating to the new platform for easier management in the future.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > Phone Device/USB Device/Room Device/Workspace Device/RPS Device.
|
||||
3. On the right side of the device, click Manage enterprise to go to the device list of the corresponding
|
||||
enterprise.
|
||||
4.
|
||||
|
||||
|
||||
|
||||
|
||||
40 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
View Term of Services and Privacy
|
||||
Policy
|
||||
View the Latest Version of the Terms of Services and
|
||||
Privacy Policy
|
||||
Procedure
|
||||
1. Do one of the following:
|
||||
For the initial login, you can check the Terms of Services and Privacy Policy after you enter your account
|
||||
credentials and click Sign In.
|
||||
|
||||
|
||||
|
||||
|
||||
After you sign in to YMCS, you can also click > Term of Services/Privacy Policy to view the
|
||||
Term of Services and Privacy Policy.
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
View the History Version
|
||||
Introduction
|
||||
The Terms of Service and Privacy Policy will be periodically refined and
|
||||
updated. Please read them carefully and confirm whether you wish to continue
|
||||
using the service.
|
||||
Procedure
|
||||
|
||||
1. After you sign in to YMCS, click > Term of Services/Privacy Policy.
|
||||
2. Click History to view the history versions of the Terms of Services and Privacy Policy.
|
||||
|
||||
|
||||
|
||||
|
||||
42 / 43
|
||||
Yealink Management Cloud Service(YMCS) Channel User
|
||||
Guide
|
||||
|
||||
|
||||
|
||||
|
||||
43 / 43
|
||||
@@ -0,0 +1,527 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 1-20
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 1-20 of 953
|
||||
**Chunk:** 1
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Switch Between Device
|
||||
Management Platform
|
||||
Workspace Management
|
||||
Platform RPS Service
|
||||
Introduction
|
||||
Device Management (DM) Platform: Designed specifically for device administrators, it
|
||||
provides a powerful and user-friendly solution for batch management and operation. It
|
||||
includes features such as monitoring, upgrading, configuring, alerting, and diagnostics.
|
||||
Workspace Management (WM) Platform: It offers a management solution for enterprise
|
||||
hybrid workspaces. In addition to the existing features, WM will gradually introduce more
|
||||
functionalities related to enterprise spaces.
|
||||
RPS Service: Simplifying the deployment and configuration process of devices, it provides a
|
||||
more efficient, convenient, and reliable solution for device deployment and configuration.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. You can switch between the DM Platform / the WM Platform / RPS Service in the bottom left
|
||||
corner.
|
||||
|
||||
💡 TIP
|
||||
You can also set the DM Platform / the WM Platform / RPS Service as
|
||||
default login platforms in Account Settingsaccording to your needs.
|
||||
|
||||
|
||||
|
||||
|
||||
1 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Connect Phone Devices
|
||||
Via YMCS RPS Service (Batch Deployment)
|
||||
Procedure
|
||||
1. Import Devices to the Device List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List > Import.
|
||||
3. Select Yes or No to turn on or turn off Import Server.
|
||||
|
||||
💡 NOTE
|
||||
If you select Yes to turn on this feature, the devices will also be imported to the RPS server
|
||||
you select, and you can see them on RPS Device list.
|
||||
|
||||
|
||||
4. Click Download Template. Edit the device information according to the guidance in the
|
||||
template.
|
||||
5. Save the file and upload it.
|
||||
6. Click Upload.
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Initialize the Device
|
||||
For brand-new devices, power up the device to complete initialization.
|
||||
For devices you have used, restore the device to factory settings to complete initialization.
|
||||
3. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the phone device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
|
||||
Via Auto Provisioning Server (Batch Deployment)
|
||||
Introduction
|
||||
|
||||
|
||||
4 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Prerequisites
|
||||
If your device's firmware version is too low, do any of the following to upgrade it
|
||||
to the latest version:
|
||||
Visit Yealink Support to get the latest device firmware version.
|
||||
Execute the following command to upgrade the device firmware.
|
||||
static.firmware.url=http://192.168.1.20/150.86.0.5.rom
|
||||
|
||||
💡 NOTE
|
||||
Please change the above http://192.168.1.20/150.86.0.5.rom to the address of
|
||||
your auto-provisioning server.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Configure the Device CFG File
|
||||
1. Perform the following configuration.
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=eu-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the EU region, configure the following
|
||||
commands:
|
||||
5 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=us-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the US region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=us-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the AU region, configure the following
|
||||
commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=au-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the UAE region, configure the following
|
||||
commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=uae-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
|
||||
6 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can find this address in the DM Server address field by going to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information on YMCS.
|
||||
|
||||
|
||||
|
||||
static.dm.enterprise_id=Enterprise ID
|
||||
static.dm.site_id=site ID
|
||||
|
||||
2. If you want to connect the device directly to a specific site in your enterprise, add the
|
||||
following command to the CFG file:
|
||||
|
||||
💡 NOTE
|
||||
|
||||
7 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the enterprise ID.
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
8 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Settings > Device > Site to get the site ID from the site information.
|
||||
|
||||
|
||||
|
||||
3. The CFG file is configured.
|
||||
2. Make Devices Access the CFG File
|
||||
Make the devices access the CFG files stored in your auto-provisioning servers.
|
||||
The operation of different auto-provisioning servers might vary, so we do not
|
||||
elaborate on the process here.
|
||||
3. Trigger the Device to Perform Auto Provisioning
|
||||
There are various ways to trigger the device to complete the auto-provisioning,
|
||||
e.g., turn the device on. Please select your desired method.
|
||||
4. Import Devices to the Device List
|
||||
|
||||
9 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
If you have set the enterprise ID and site ID in the Configure Device CFG
|
||||
file operation, the device will be automatically added to the device list in
|
||||
YMCS; if not, see Import devices.
|
||||
|
||||
5. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the phone device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
|
||||
Via DHCP Option (Batch Deployment)
|
||||
Introduction
|
||||
You can configure devices to obtain the provisioning server address via DHCP.
|
||||
|
||||
Procedure
|
||||
1. Set Up the DHCP Server
|
||||
If you do not have a DHCP server, you can see this section to set up one.
|
||||
Following, we use DHCP Server for Windows to illustrate how to set up a DHCP
|
||||
server on the Windows operating system.
|
||||
1. Download DHCP Server.
|
||||
2. Run dhcpsrv.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
10 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Select your network interface card and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Configure your IP pool, click DHCP Options, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
11 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Do one of the following:
|
||||
Enter the DHCP option and Yealink auto-provisioning server addresses, and click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Param Introduction
|
||||
eter
|
||||
|
||||
Option Enter the option number.
|
||||
numbe
|
||||
r
|
||||
|
||||
Option Set the DHCP option value (the address of the auto-provisioning
|
||||
string server) and enclose it with quotation marks.
|
||||
You can use Yealink auto-provisioning server addresses. Following
|
||||
are Yealink auto-provisioning addresses:
|
||||
If your enterprise is in the EU region, enter https://eu-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
|
||||
12 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If your enterprise is in the US region, enter https://us-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
|
||||
If your enterprise is in the AU region, enter https://au-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
If your enterprise is in the UAE region, enter https://uae-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
|
||||
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the Yealink auto-provisioning
|
||||
address.
|
||||
|
||||
Enter the DHCP option and your own auto-provisioning server addresses, and
|
||||
click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Param Introduction
|
||||
eter
|
||||
|
||||
Option Enter the option number.
|
||||
numbe
|
||||
r
|
||||
|
||||
13 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Option Set the DHCP option value (the address of the auto-provisioning
|
||||
string server) and enclose it with quotation marks.
|
||||
You can use your own auto-provisioning server addresses.
|
||||
|
||||
Please follow the steps below to configure the Device CFG File:
|
||||
7. Perform the following configuration.
|
||||
If your enterprise is located in the EU region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=eu-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the US region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=us-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the AU region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=au-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the UAE region, configure the following commands:
|
||||
|
||||
|
||||
14 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=uae-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can find this address in the DM Server address field by going to
|
||||
System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information on YMCS.
|
||||
|
||||
15 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If you want to connect the device directly to a specific site in your enterprise, add the
|
||||
following command to the CFG file:
|
||||
|
||||
static.dm.enterprise_id=Enterprise ID
|
||||
static.dm.site_id=site ID
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the enterprise ID.
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
16 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Settings > Device > Site to get the site ID from the site information.
|
||||
|
||||
i. The CFG file is configured.
|
||||
8. Click OK > Next.
|
||||
|
||||
|
||||
|
||||
|
||||
17 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
9. Select Overwrite existing file, click Write INI file, and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
10. Click Start to run the server and click Finish to exit.
|
||||
2. Make Devices Obtain Server Address through DHCP
|
||||
Yealink IP phones can obtain the provisioning server address by detecting DHCP
|
||||
options during startup.
|
||||
|
||||
18 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If you do not use the following default option value, you need to configure the
|
||||
phone to obtain the provisioning server address via a custom DHCP option.
|
||||
|
||||
Netw Default Introduction
|
||||
ork option
|
||||
type value
|
||||
|
||||
IPv4 Option 66, Option 66 is used to identify the TFTP server.
|
||||
Option 43 Option 43 is a vendor-specific option, which is used to
|
||||
transfer the vendor-specific information.
|
||||
|
||||
IPv6 Option 59 Option 59 is used to specify a URL for the boot file to be
|
||||
downloaded by the client.
|
||||
|
||||
If you use the default option value:
|
||||
1. Reconnect the network cable of your devices or restart the devices to make them obtain
|
||||
the server address.
|
||||
|
||||
If you use a custom DHCP option:
|
||||
2. Enter https://phone IP address (for example, https://1.2.3.4) in the browser address bar and
|
||||
log in to the phone web user interface as an administrator.
|
||||
3. Click Settings > Auto Provision.
|
||||
4. Select the On radio box in the DHCP Active field.
|
||||
5. Do one of the following:
|
||||
If you are using IPv4 network, enter the desired value in the IPv4 Custom Option field.
|
||||
If you are using IPv6 network, enter the desired value in the IPv6 Custom Option field.
|
||||
|
||||
💡 NOTE
|
||||
The IPv4 or IPv6 custom DHCP option must be in accordance with the one defined in the
|
||||
DHCP server.
|
||||
|
||||
|
||||
6. Click Confirm to accept the change.
|
||||
7. Reconnect the network cable of your devices or restart the devices to make them obtain
|
||||
the server address.
|
||||
3. Add Devices to the Device List
|
||||
💡 NOTE
|
||||
|
||||
|
||||
19 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If you have set the enterprise ID and site ID in Step 1, the device will be
|
||||
automatically added to the device list in YMCS; if not, see import devices.
|
||||
|
||||
4. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the phone device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
Via the Device Web User Interface (for a Single
|
||||
Device)
|
||||
Procedure
|
||||
1. Configure Auto-Provisioning Server Address
|
||||
1. (Take T41U as an example) Enter https://phone IP address (for example, https://1.2.3.4) in
|
||||
the browser address bar and log in to the phone web user interface as an administrator.
|
||||
2. Click Settings > Auto Provision.
|
||||
3. Enter the URL of your auto-provisioning server in the Server URL field.
|
||||
If your enterprise is in the EU region, enter https://eu-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
If your enterprise is in the US region, enter https://us-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
If your enterprise is in the AU region, enter https://au-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
If your enterprise is in the UAE region, enter https://uae-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
20 / 82
|
||||
@@ -0,0 +1,519 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 21-40
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 21-40 of 953
|
||||
**Chunk:** 2
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the AutoP address.
|
||||
|
||||
|
||||
|
||||
|
||||
21 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Auto Provision Now, and reconfirm in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add Devices to the Device List on YMCS
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List > Add
|
||||
3. Edit device-related information.
|
||||
|
||||
Paramet Introduction
|
||||
er
|
||||
|
||||
Device Enter the device name.
|
||||
Name
|
||||
|
||||
22 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
MAC Enter the MAC address of the device. MAC must and can only
|
||||
contain 12 letters or numbers; the length is limited to 12-17
|
||||
characters; the characters that can be entered include 0-9, A-z,
|
||||
"-", ":"; for example, 00-15-65-1a-2b-3c, 00:15:65:1a:2b:3c,
|
||||
0015651a2B3c.
|
||||
|
||||
Machine Enter the Machine ID of the device. The Machine ID is the SN
|
||||
ID corresponding to the body sticker or the Machine ID displayed in
|
||||
the device status information.
|
||||
|
||||
Model Select the device model.
|
||||
|
||||
Site Select a site for the device.
|
||||
|
||||
Bind Bind an account for the device.
|
||||
Account
|
||||
|
||||
Descript Enter a description.
|
||||
ion
|
||||
|
||||
4. Click Save.
|
||||
3. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the phone device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
|
||||
|
||||
|
||||
23 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Connect Android-based Video
|
||||
Conferencing Endpoints & Smart
|
||||
Workspace Devices
|
||||
💡 TIP
|
||||
This connecting method is applicable to models: MeetingBar AX0/
|
||||
MeetingBoard/DeskVision A24/RoomCast/RoomPanel/RoomPanel Plus/
|
||||
CTP18/CTP25.
|
||||
For CTP18/CTP25, independent connecting through this method is only
|
||||
supported when paired with a host device. About pairing with a host
|
||||
device, please refer to Pair with Devices.
|
||||
|
||||
Via Auto Provisioning Server (Batch Deployment)
|
||||
Via DHCP Option (Batch Deployment)
|
||||
Via the Device Web User Interface (for a Single Device)
|
||||
|
||||
|
||||
|
||||
Via Auto Provisioning Server (Batch
|
||||
Deployment)
|
||||
Introduction
|
||||
|
||||
|
||||
|
||||
|
||||
24 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Prerequisites
|
||||
If your device's firmware version is too low, do any of the following to upgrade it
|
||||
to the latest version:
|
||||
Visit Yealink Support to get the latest device firmware version.
|
||||
Execute the following command to upgrade the device firmware
|
||||
|
||||
static.firmware.url=http://192.168.1.20/150.86.0.5.rom
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Please change the above http://192.168.1.20/150.86.0.5.rom to the address of
|
||||
your auto-provisioning server.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Configure the Device CFG File
|
||||
1. Perform the following configuration.
|
||||
If your enterprise is located in the EU region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=eu-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the US region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=us-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the AU region, configure the following commands:
|
||||
|
||||
25 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=au-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the UAE region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=uae-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can find this address in the DM Server address field by going to System (
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information on YMCS.
|
||||
|
||||
|
||||
2. If you want to connect the device directly to a specific site in your enterprise, add the
|
||||
following command to the CFG file:
|
||||
|
||||
static.dm.enterprise_id=Enterprise ID
|
||||
static.dm.site_id=site ID
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
27 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the enterprise ID.
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Settings > Device > Site to get the site ID from the site information.
|
||||
|
||||
3. The CFG file is configured.
|
||||
2. Make Devices Access the CFG File
|
||||
Make the devices access the CFG files stored in your auto-provisioning servers.
|
||||
The operation of different auto-provisioning servers might vary, so we do not
|
||||
elaborate on the process here.
|
||||
3. Trigger the Device to Perform Auto Provisioning
|
||||
There are various ways to trigger the device to complete the auto-provisioning,
|
||||
e.g., turn the device on. Please select your desired method.
|
||||
4. Import Devices to the Device List
|
||||
|
||||
|
||||
|
||||
29 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
If you have set the enterprise ID and site ID in the Configure Device CFG
|
||||
file operation, the device will be automatically added to the device list in
|
||||
YMCS; if not, see Import Devices.
|
||||
|
||||
5. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the phone device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
|
||||
|
||||
Via DHCP Option (Batch Deployment)
|
||||
Introduction
|
||||
You can configure devices to obtain the provisioning server address via DHCP.
|
||||
|
||||
Procedure
|
||||
1. Set Up the DHCP Server
|
||||
If you do not have a DHCP server, you can see this section to set up one.
|
||||
Following, we use DHCP Server for Windows to illustrate how to set up a DHCP
|
||||
server on the Windows operating system.
|
||||
1. Download DHCP Server.
|
||||
2. Run dhcpsrv.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Select your network interface card and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Configure your IP pool, click DHCP Options, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
31 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Do one of the following:
|
||||
Enter the DHCP option and Yealink auto-provisioning server addresses, and click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Paramet Introduction
|
||||
er
|
||||
|
||||
Option Enter the option number.
|
||||
number
|
||||
|
||||
Option Set the DHCP option value (the address of the auto-provisioning
|
||||
string server) and enclose it with quotation marks.
|
||||
You can use Yealink auto-provisioning server addresses.
|
||||
Following are Yealink auto-provisioning addresses:
|
||||
If your enterprise is in the EU region, enter https://eu-
|
||||
|
||||
|
||||
32 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
|
||||
If your enterprise is in the US region, enter https://us-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
|
||||
If your enterprise is in the AU region, enter https://au-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
If your enterprise is in the UAE region, enter https://uae-
|
||||
resource.ymcs.yealink.com/hardware/autop/$MAC.boot
|
||||
|
||||
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the Yealink auto-provisioning
|
||||
address.
|
||||
|
||||
Enter the DHCP option and your own auto-provisioning server addresses, and click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Param Introduction
|
||||
eter
|
||||
|
||||
Option Enter the option number.
|
||||
numbe
|
||||
r
|
||||
|
||||
33 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Option Set the DHCP option value (the address of the auto-provisioning
|
||||
string server) and enclose it with quotation marks.
|
||||
You can use your own auto-provisioning server addresses.
|
||||
|
||||
Please follow the steps below to configure the Device CFG File:
|
||||
1. Perform the following configuration.
|
||||
If your enterprise is located in the EU region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=eu-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the US region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=us-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the AU region, configure the following commands:
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=au-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
If your enterprise is located in the UAE region, configure the following commands:
|
||||
|
||||
|
||||
34 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
#!version:1.0.0.1
|
||||
##The header above must appear as-is in the first line
|
||||
dm.enable=1
|
||||
dm.server.address=uae-device-scheduler.ymcs.yealink.com
|
||||
dm.server.port=443
|
||||
dm.file_upload.http_post_mode=0
|
||||
dm.file_upload.http_method=1
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can find this address in the DM Server address field by going to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information on YMCS.
|
||||
|
||||
|
||||
2. If you want to connect the device directly to a specific site in your enterprise, add the
|
||||
|
||||
|
||||
35 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
following command to the CFG file:
|
||||
|
||||
static.dm.enterprise_id=Enterprise ID
|
||||
static.dm.site_id=site ID
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the enterprise ID.
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
36 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Settings > Device > Site to get the site ID from the site information.
|
||||
|
||||
3. The CFG file is configured.
|
||||
4. Click OK > Next.
|
||||
|
||||
|
||||
|
||||
|
||||
37 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select Overwrite existing file, click Write INI file, and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Start to run the server and click Finish to exit.
|
||||
|
||||
|
||||
|
||||
|
||||
38 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Make Devices Obtain Server Address through DHCP
|
||||
Yealink IP phones can obtain the provisioning server address by detecting DHCP
|
||||
options during startup.
|
||||
If you do not use the following default option value, you need to configure the
|
||||
phone to obtain the provisioning server address via a custom DHCP option.
|
||||
|
||||
Netw Default Introduction
|
||||
ork option
|
||||
type value
|
||||
|
||||
IPv4 Option 66, Option 66 is used to identify the TFTP server.
|
||||
Option 43 Option 43 is a vendor-specific option, which is used to
|
||||
transfer the vendor-specific information.
|
||||
|
||||
IPv6 Option 59 Option 59 is used to specify a URL for the boot file to be
|
||||
downloaded by the client.
|
||||
|
||||
39 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If you use the default option value:
|
||||
1. Reconnect the network cable of your devices or restart the devices to make them obtain
|
||||
the server address.
|
||||
|
||||
If you use a custom DHCP option:
|
||||
1. Enter https://phone IP address (for example, https://1.2.3.4) in the browser address bar and
|
||||
log in to the phone web user interface as an administrator.
|
||||
2. Click System > Auto Provision.
|
||||
3. Enable DHCP Active.
|
||||
4. Do one of the following:
|
||||
If you are using IPv4 network, enter the desired value in the IPv4 Custom Option field.
|
||||
If you are using IPv6 network, enter the desired value in the IPv6 Custom Option field.
|
||||
|
||||
💡 NOTE
|
||||
The IPv4 or IPv6 custom DHCP option must be in accordance with the one defined in the
|
||||
DHCP server.
|
||||
|
||||
|
||||
5. Click Confirm to accept the change.
|
||||
6. Reconnect the network cable of your devices or restart the devices to make them obtain
|
||||
the server address.
|
||||
3. Add Devices to the Device List
|
||||
💡 NOTE
|
||||
If you have set the enterprise ID and site ID in Step 1, the device will be
|
||||
automatically added to the device list in YMCS; if not, see Import Devices.
|
||||
|
||||
4. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the phone device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
|
||||
|
||||
Via the Device Web User Interface (for a
|
||||
Single Device)
|
||||
|
||||
40 / 82
|
||||
@@ -0,0 +1,425 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 41-60
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 41-60 of 953
|
||||
**Chunk:** 3
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
Supported devices:
|
||||
|
||||
Models MVC/ZVC Meeting Meeti MeetingDi Room Room
|
||||
Board ngBar splay Panel Cast
|
||||
|
||||
Support Not Support Suppor Supported Suppo Suppo
|
||||
Status Supporte ed ted rted rted
|
||||
d
|
||||
|
||||
1. Configure on the device
|
||||
💡 NOTE
|
||||
1. Click System > Enterprise information in YMCS to obtain the Enterprise ID,
|
||||
|
||||
AutoP address, and DM Server address.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click Workspace > Rooms in YMCS to obtain the Deployment code.
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Please choose from the following three configuration methods that your
|
||||
device supports:
|
||||
Method 1
|
||||
1. Please enter the device, click Device Settings > Yealink Could Service.
|
||||
2. Enable the Yealink Cloud Service .
|
||||
3. Enable the Yealink Management Cloud Service.
|
||||
4. Select the Yealink Management Cloud Service in the Device Manage Server.
|
||||
5. Input the Deployment code or Enterprise ID.
|
||||
6. Click Confirm
|
||||
|
||||
|
||||
|
||||
|
||||
42 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
43 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the Deployment code or Enterprise ID in the
|
||||
YMCS (https://eu.ymcs.yealink.com).
|
||||
|
||||
Method 2
|
||||
1. Enter https://device IP address (for example, https://1.2.3.4) in the browser address bar and
|
||||
log in to the phone web user interface as an administrator.
|
||||
2. Click System > Yealink Cloud Service (If you have this menu).
|
||||
3. Enable the Yealink Cloud Service (If you have this configuration).
|
||||
4. Enable the Yealink Management Cloud Service(If you have this configuration).
|
||||
5. Select the Yealink Management Cloud Service in the Device Manage Platform.
|
||||
6. Input the Deployment code or Enterprise ID (Lower versions do not support deployment
|
||||
codes. Please use the enterprise id or leave it blank) .
|
||||
7. Click Confirm
|
||||
|
||||
44 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
45 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the Deployment code or Enterprise ID in the
|
||||
YMCS (https://eu.ymcs.yealink.com).
|
||||
|
||||
Method 3
|
||||
1. Enter https://device IP address (for example, https://1.2.3.4) in the browser address bar and
|
||||
log in to the phone web user interface as an administrator.
|
||||
2. Click System > Yealink Cloud Service(If you have this menu).
|
||||
3. Enable the Yealink Cloud Service (If you have this configuration).
|
||||
4. Enable the Yealink Management Cloud Service(If you have this configuration).
|
||||
5. Click System > Device Manage.
|
||||
6. Enter the URL of your AutoP address in the Server URL field.
|
||||
If your enterprise is in the EU region, enter https://eu-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
|
||||
46 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If your enterprise is in the US region, enter https://us-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
If your enterprise is in the AU region, enter https://au-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
If your enterprise is in the UAE region, enter https://uae-resource.ymcs.yealink.com/
|
||||
hardware/autop/$MAC.boot
|
||||
7. Click Auto Provision Now.
|
||||
|
||||
💡 NOTE
|
||||
You can go to System (
|
||||
|
||||
|
||||
|
||||
|
||||
) > Enterprise Information to get the AutoP address in the YMCS (https://eu.ymcs.yealink.com).
|
||||
|
||||
|
||||
|
||||
|
||||
47 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add Devices to the Device List on YMCS
|
||||
💡 NOTE
|
||||
If using method 1 & method 2 and entering the correct deployment code,
|
||||
please skip this step.
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device >Device > Room Device > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit device-related information.
|
||||
|
||||
Parameter Introduction
|
||||
|
||||
Device Enter the device name.
|
||||
|
||||
|
||||
48 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Name
|
||||
|
||||
MAC Enter the MAC address of the device. MAC must and can only
|
||||
contain 12 letters or numbers; the length is limited to 12-17
|
||||
characters; the characters that can be entered include 0-9, A-
|
||||
z, "-", ":"; for example, 00-15-65-1a-2b-3c, 00:15:65:1a:2b:3c,
|
||||
0015651a2B3c.
|
||||
|
||||
Machine ID Enter the Machine ID of the device. The Machine ID is the SN
|
||||
corresponding to the body sticker or the Machine ID
|
||||
displayed in the device status information.
|
||||
|
||||
Model Select the device model.
|
||||
|
||||
Site Select a site for the device.
|
||||
|
||||
Bind Bind an account for the device.
|
||||
Account
|
||||
|
||||
Description Enter a description.
|
||||
|
||||
4. Click Save.
|
||||
3. Devices Are Successfully Connected to YMCS
|
||||
After the device successfully connects to YMCS, the device status changes from
|
||||
"offline" to "online" in the room device list; the device status changes from
|
||||
"unbound" to "bound" in the RPS device list, which means that the device is
|
||||
successfully connected through the RPS server.
|
||||
|
||||
|
||||
|
||||
|
||||
49 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Connect Windows-based Video
|
||||
Conferencing Endpoints (MVC
|
||||
and ZVC Series)
|
||||
Batch Deployment via Yealink
|
||||
RoomConnect
|
||||
Prerequisites
|
||||
The software version of YRC built into the devices should be 2.31.67.0 or higher.
|
||||
|
||||
Procedure
|
||||
1. Import Devices
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
On the DM platform, click Room Device > Device > Device List > Import.
|
||||
On the WM platform, click Workspace > Rooms > Devices >Import.
|
||||
3. Click Download Template. Edit the device information according to the guidance in the
|
||||
template.
|
||||
4. Save the file and upload it.
|
||||
5. Click Upload.
|
||||
|
||||
|
||||
|
||||
|
||||
50 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Power On Devices
|
||||
After you power on the devices, the devices will connect to YMCS via YRC.
|
||||
3. Devices Are Successfully Connected to YMCS
|
||||
After the device is successfully connected to YMCS, the device status will change
|
||||
from "offline" to "online" in the room device list.
|
||||
|
||||
|
||||
|
||||
|
||||
Via Yealink RoomConnect Software
|
||||
Procedure
|
||||
1. Connect Room Devices to YMCS via YRC
|
||||
Method 1: Classic Login
|
||||
|
||||
💡 NOTE
|
||||
The software version of YRC built into the devices should be 2.33.0.0 or
|
||||
|
||||
|
||||
51 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
higher.
|
||||
|
||||
1. Open Yealink RoomConnect software and click
|
||||
|
||||
|
||||
|
||||
|
||||
> DM Server Settings > Classic Login.
|
||||
|
||||
|
||||
|
||||
|
||||
52 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Make the relevant settings and click Connect to platform.
|
||||
Connect to platform: Choose Yealink Management Cloud Service.
|
||||
|
||||
|
||||
|
||||
|
||||
Enterprise ID: Enter the enterprise ID.
|
||||
|
||||
💡 NOTE
|
||||
You can obtain the enterprise ID in Enterprise Information.
|
||||
|
||||
|
||||
Meeting Room: Enter the meeting room name.
|
||||
Device Model: Select the device model.
|
||||
|
||||
53 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Authorize Remote Screenshot: Choose whether to grant remote screen capture
|
||||
permission to administrators.
|
||||
Authorize Remote Desktop: Choose whether to grant remote desktop permission to
|
||||
administrators.
|
||||
|
||||
|
||||
|
||||
|
||||
Method 2: Account Password Login
|
||||
|
||||
💡 NOTE
|
||||
The software version of YRC built into the devices should be 2.31.67.0 or
|
||||
higher.
|
||||
|
||||
1. Open Yealink RoomConnect software and click
|
||||
|
||||
|
||||
|
||||
|
||||
54 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> DM Server Settings > Account Password Login.
|
||||
|
||||
|
||||
|
||||
|
||||
55 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
1. Enter your YMCS account credentials (the enterprise registration account) and click Login.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Confirm the information, such as meeting room, enterprise name and device name, then
|
||||
click Confirm.
|
||||
|
||||
|
||||
|
||||
|
||||
56 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Devices Are Successfully Connected to YMCS
|
||||
After the device is successfully connected to YMCS, the device status will change
|
||||
from "offline" to "online" in the room device list. You can view and modify the
|
||||
relevant information in the setting interface of Yealink RoomConnect software.
|
||||
|
||||
|
||||
|
||||
|
||||
57 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Connect USB Devices
|
||||
Install the YUC Package in Bulk on User Computers
|
||||
Introduction
|
||||
There are various methods available for bulk-installing the YUC installation
|
||||
package on user computers. You can choose the most suitable bulk installation
|
||||
method based on your enterprise's specific environment. The following guide
|
||||
explains how to use Intune for bulk installation. Installing through Intune is a
|
||||
seamless process for your enterprise employees, and they won't even notice it.
|
||||
|
||||
Install the YUC Package in Bulk for Windows
|
||||
09081035Mac intune视频1e87d19.autosave.mp4
|
||||
|
||||
About how to get the package, please refer to: How to get the package uploaded to
|
||||
Intune when using Intune to install a batch of packages to Windows users?
|
||||
|
||||
Install the YUC Package in Bulk for macOS
|
||||
How to Install YUC in Bulk for Users' Computers（Windows) with Intune.mp4
|
||||
|
||||
About how to set shell scripts, please refer to: How to set shell scripts when using
|
||||
Intune to install a batch of packages to MacOS users?
|
||||
|
||||
|
||||
|
||||
|
||||
Batch Deployment for Windows
|
||||
💡 Warning
|
||||
Before batch deployment, make sure you have the file installation and
|
||||
access permissions of your enterprise so that the batch installation can
|
||||
be carried out successfully.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Download YUC Package
|
||||
58 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Bulk Deployment.
|
||||
3. Set the site settings.
|
||||
If you select Do not specify a site, the USB devices will belong to the root site after they
|
||||
are connected to YMCS. You can then adjust the device belonging site in the platform.
|
||||
If you select Specify a site, select the desired belonging site. The USB devices will belong
|
||||
to your chosen site.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You cannot directly change the belonging site for the device on the YMCS web portal. To
|
||||
change the site, regenerate and redeploy the installation package.
|
||||
|
||||
|
||||
4. Select Windows and click Download.
|
||||
5. Click Download from the window that popped up in the bottom-right corner.
|
||||
|
||||
|
||||
|
||||
|
||||
59 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
7. You can also click Download from the Export Records to obtain the YUC package.
|
||||
|
||||
|
||||
|
||||
|
||||
60 / 82
|
||||
@@ -0,0 +1,478 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 61-80
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 61-80 of 953
|
||||
**Chunk:** 4
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Install the YUC Package in Bulk on User Computers
|
||||
There are multiple methods available to perform bulk installations of the YUC
|
||||
package on user computers. You can choose the appropriate method based on
|
||||
your enterprise's specific environment. Below is an explanation of how to use
|
||||
Intune to perform bulk installation of the package on user computers.
|
||||
|
||||
|
||||
About how to get the package, please refer to: How to get the package uploaded to
|
||||
Intune when using Intune to install a batch of packages to Windows users?
|
||||
3. Connect Devices to Computers
|
||||
Connect devices to the computer, and you can see the device on YUC.
|
||||
|
||||
|
||||
|
||||
|
||||
61 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Devices Are Successfully Connected to YMCS
|
||||
After the device is successfully connected to YMCS, the device status will change
|
||||
from “offline” to “online” in the room device list.
|
||||
|
||||
FAQ
|
||||
How to connect the USB device to a new enterprise?
|
||||
In this scenario, the USB device is already connected to Enterprise A, and you
|
||||
want to connect it to Enterprise B.
|
||||
If Enterprise A and Enterprise B are in the same data center, performing the above steps will
|
||||
automatically remove the device from Enterprise A to Enterprise B.
|
||||
If Enterprise A and Enterprise B are in different data centers, you need to manually remove
|
||||
the devices from Enterprise A, and perform the above steps to connect the USB device to
|
||||
Enterprise B.
|
||||
|
||||
💡 Warning
|
||||
Before batch deployment, make sure you have the file installation and
|
||||
access permissions of your enterprise so that the batch installation can
|
||||
be carried out successfully.
|
||||
|
||||
|
||||
Batch Deployment for macOS
|
||||
Procedure
|
||||
|
||||
62 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Download YUC Package
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Bulk Deployment.
|
||||
3. Set the site settings.
|
||||
If you select Do not specify a site, the USB devices will belong to the root site after they
|
||||
are connected to YMCS. You can then adjust the device belonging site in the platform.
|
||||
If you select Specify a site, select the desired belonging site. The USB devices will belong
|
||||
to your chosen site.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You cannot directly change the belonging site for the device on the YMCS web portal. To
|
||||
change the site, regenerate and redeploy the installation package.
|
||||
|
||||
|
||||
4. Select Windows and click Download.
|
||||
5. Click Download from the window that popped up in the bottom-right corner.
|
||||
|
||||
|
||||
|
||||
|
||||
63 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
7. You can also click Download from the Export Records to obtain the YUC package.
|
||||
|
||||
|
||||
|
||||
|
||||
64 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Install the YUC Package in Bulk on User Computers
|
||||
There are multiple methods available to perform bulk installations of the YUC
|
||||
package on user computers. You can choose the appropriate method based on
|
||||
your enterprise's specific environment. Below is an explanation of how to use
|
||||
Intune to perform bulk installation of the package on user computers.
|
||||
|
||||
|
||||
About how to set shell scripts, please refer to: How to set shell scripts when using
|
||||
Intune to install a batch of packages to MacOS users?
|
||||
3. Connect Devices to Computers
|
||||
Connect devices to the computer, and you can see the device on YUC.
|
||||
|
||||
|
||||
|
||||
|
||||
65 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Devices Are Successfully Connected to YMCS
|
||||
After the device is successfully connected to YMCS, the device status will change
|
||||
from “offline” to “online” in the room device list.
|
||||
|
||||
FAQ
|
||||
How to connect the USB device to a new enterprise?
|
||||
In this scenario, the USB device is already connected to Enterprise A, and you
|
||||
want to connect it to Enterprise B.
|
||||
If Enterprise A and Enterprise B are in the same data center, performing the above steps will
|
||||
automatically remove the device from Enterprise A to Enterprise B.
|
||||
If Enterprise A and Enterprise B are in different data centers, you need to manually remove
|
||||
the devices from Enterprise A, and perform the above steps to connect the USB device to
|
||||
Enterprise B.
|
||||
|
||||
|
||||
|
||||
|
||||
66 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In with General Accounts
|
||||
Introduction
|
||||
The login portal of YMCS for Enterprise is divided into EU, US, AU and UAE
|
||||
regions. Superior channels create the enterprise account, and you can check
|
||||
your email for the login address, username, and password.
|
||||
|
||||
Region Address
|
||||
|
||||
EU region https://eu.ymcs.yealink.com/manager/login
|
||||
|
||||
US region https://us.ymcs.yealink.com/manager/login
|
||||
|
||||
AU region https://au.ymcs.yealink.com/manager/login
|
||||
UAE region https://uae.ymcs.yealink.com/manager/login
|
||||
|
||||
|
||||
💡 TIP
|
||||
By logging in via the global address (https://ymcs.yealink.com/manager/
|
||||
login), YMCS will automatically detect and redirect you to the region you
|
||||
locate.
|
||||
|
||||
Procedure
|
||||
1. For the first login, click the login address in the email or enter the login address in the
|
||||
browser address bar.
|
||||
2. Optional: Switch the language in the top-right corner.
|
||||
3. Enter your username and password and click Sign In.
|
||||
|
||||
💡 NOTE
|
||||
If you are a first-time user, the system will prompt you to agree to the use of
|
||||
cookies, accept the privacy policy and terms of service, and update your password
|
||||
if necessary.
|
||||
If your enterprise has enabled login protection to enhance login security, you need
|
||||
to perform identity verification after logging in. For more information, see Login
|
||||
Protection.
|
||||
|
||||
|
||||
67 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
68 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Single Sign-On
|
||||
You can also log in via SSO, which is using your Microsoft account to easily log in
|
||||
to the YMCS platform, effectively improving login efficiency, and avoiding some
|
||||
of the security risks.
|
||||
|
||||
|
||||
|
||||
|
||||
69 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Home
|
||||
The homepage provides you with an entry point for an overview of the
|
||||
enterprise and commonly used functions, allowing you to quickly understand
|
||||
and get started.
|
||||
Home Page
|
||||
|
||||
|
||||
|
||||
|
||||
Num Description
|
||||
ber
|
||||
|
||||
1 All functional modules in Device Management, including: Phone
|
||||
Device, Room Device, Personal device, Monitor Wall, System Management.
|
||||
|
||||
2 Click to switch to Workspace Management.
|
||||
|
||||
3 Click to switch to RPS service.
|
||||
|
||||
4 Click to view personal information, set up accounts, switch
|
||||
languages, view privacy policies and terms of service, and log out.
|
||||
|
||||
5 Click to view the file export record.
|
||||
|
||||
70 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
6 Click to view the platform usage guide or provide feedback.
|
||||
|
||||
7 Click to collapse/expand the navigation bar.
|
||||
|
||||
8 Click to switch Phone Workstation/Rooms Workstation/USB
|
||||
Workstation. Specific instructions can be found below.
|
||||
|
||||
9 Click to refresh the interface.
|
||||
|
||||
Phone Workstation
|
||||
|
||||
|
||||
|
||||
|
||||
71 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Nu Description
|
||||
mbe
|
||||
r
|
||||
|
||||
1 Switch sites in the site directory to view the dashboard of the phone
|
||||
devices in that site.
|
||||
|
||||
2 Based on your choice of site, view the site, sub-account, and total
|
||||
number of orders under the site, and click to jump to the
|
||||
corresponding interface.
|
||||
|
||||
3 Displays the total number of devices. Click to jump to the
|
||||
corresponding device list.
|
||||
|
||||
4 Provide Device Configuration, Site Configuration, Group Configuration, Global
|
||||
configuration, Device Statistics, Firmware quick entry.
|
||||
|
||||
5 Displays the proportion and quantity of the device status. Click the
|
||||
sector to jump to the list of devices in that status.
|
||||
|
||||
6 Enter the Mac/IP/Machine ID of the device for quick diagnosis.
|
||||
|
||||
7 Display unhandled alarms and their severity. Click All to jump to Alarm
|
||||
List .
|
||||
|
||||
8 Displays the proportion and quantity of each device model. Click the
|
||||
horizontal axis to jump to the device list of that model; click All to go
|
||||
to Device List.
|
||||
|
||||
9 Displays the total number of calls and call quality. Click the vertical
|
||||
axis to jump to the Call Quality Statistics interface for that date. .
|
||||
|
||||
10 Displays the execution results of scheduled tasks and tasks to be
|
||||
executed in the past 7 days. Click All to jump to Task Management.
|
||||
|
||||
💡 NOTE
|
||||
This data is not affected by site filtering.
|
||||
|
||||
|
||||
|
||||
Rooms Workstation
|
||||
72 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
N Description
|
||||
u
|
||||
m
|
||||
be
|
||||
r
|
||||
|
||||
|
||||
73 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1 Switch sites in the site directory to view the dashboard of the
|
||||
conference devices in that site.
|
||||
|
||||
2 Based on your choice of site, view the site, sub-account, and total
|
||||
number of orders under the site, and click to jump to the corresponding
|
||||
interface.
|
||||
|
||||
3 Displays the total number of devices, total accessories, and total
|
||||
number of devices offline for more than 7 days. Click to jump to the
|
||||
corresponding device list.
|
||||
|
||||
4 Provide Site configuration, Group Configuration,Device Statistics, Firmware
|
||||
Management quick entry.
|
||||
|
||||
5 Displays the proportion and quantity of the device status. Click the
|
||||
sector to jump to the list of devices in that status.
|
||||
|
||||
6 Enter the Mac/IP/Machine ID of the device for quick diagnosis.
|
||||
|
||||
7 Display unhandled alarms and their severity. Click All to jump to Alarm
|
||||
List .
|
||||
|
||||
8 Displays the proportion and quantity of each device model. Click the
|
||||
horizontal axis to jump to the device list of that model; click All to jump
|
||||
to Device List.
|
||||
|
||||
9 Display the latest firmware upgrade status interface of the host/
|
||||
accessory, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the corresponding device , you can perform the
|
||||
upgrade operation; click All to go to the Firmware Management interface.
|
||||
|
||||
10 Displays the execution results of scheduled tasks and tasks to be
|
||||
executed in the past 7 days. Click All to go toTask Management interface.
|
||||
|
||||
74 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
💡 NOTE
|
||||
This data is not affected by site filtering.
|
||||
|
||||
|
||||
|
||||
USB Workstation
|
||||
|
||||
|
||||
|
||||
|
||||
N Description
|
||||
u
|
||||
|
||||
|
||||
75 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
m
|
||||
be
|
||||
r
|
||||
|
||||
1 Switch sites in the site directory to view the dashboard of the
|
||||
conference devices in that site.
|
||||
|
||||
2 Based on your choice of site, view the site, sub-account, and total
|
||||
number of orders under the site, and click to jump to the corresponding
|
||||
interface.
|
||||
|
||||
3 Displays the total number of devices and the number of devices that
|
||||
have been offline for more than 7 days. Click to jump to the
|
||||
corresponding device list.
|
||||
|
||||
4 Provide Device configuration, Software Configuration,Data Statistics, Firmware
|
||||
Management quick entry.
|
||||
|
||||
5 Displays the proportion and quantity of software status. Click the sector
|
||||
to go to the list of software in that status.
|
||||
|
||||
6 Displays the proportion and quantity of each device model. Click the
|
||||
horizontal axis to jump to the device list of that model; click All to go to
|
||||
Device List.
|
||||
|
||||
7 Displays the execution results of scheduled tasks and tasks to be
|
||||
executed in the past 7 days. Click All to go to Task Management interface.
|
||||
|
||||
💡 NOTE
|
||||
This data is not affected by site filtering.
|
||||
|
||||
|
||||
8 The latest firmware upgrade status interface is displayed, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the corresponding device, you can perform the
|
||||
|
||||
76 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
upgrade operation; click All to jump to the Firmware Management
|
||||
interface.
|
||||
|
||||
|
||||
|
||||
|
||||
77 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Status
|
||||
Before managing devices, you can familiarize yourself with the device status and
|
||||
the active status.
|
||||
|
||||
💡 TIP
|
||||
From the device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
and select the Status and the Active Status filters.
|
||||
|
||||
|
||||
|
||||
78 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Status
|
||||
|
||||
|
||||
|
||||
|
||||
Device Status Description
|
||||
|
||||
Online The device is connected to YMCS.
|
||||
|
||||
Offline The device is disconnected from YMCS.
|
||||
|
||||
Pending The device is not reported and connected to YMCS.
|
||||
|
||||
Active Status
|
||||
|
||||
|
||||
79 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The number of devices that you can manage on YMCS depends on the
|
||||
package license you purchased from the reseller or the distributor. You
|
||||
can view the purchase packages on order management.
|
||||
If the device number does not exceed the number of the package you
|
||||
purchase, the device’s active status is Active.
|
||||
You cannot add new devices once the upper limit is reached. When
|
||||
some of your invalid orders cause some of the devices to be unable to
|
||||
manage, the device active status will become Inactive and you cannot
|
||||
manage it. If you still want to use this service, contact your superior
|
||||
channel.
|
||||
|
||||
|
||||
|
||||
|
||||
80 / 82
|
||||
@@ -0,0 +1,517 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 81-100
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 81-100 of 953
|
||||
**Chunk:** 5
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Managing Features and
|
||||
Their Supported Devices
|
||||
Supported Feature Phone Room Devices USB
|
||||
Devic
|
||||
Devic es
|
||||
es
|
||||
|
||||
Add devices √ √
|
||||
|
||||
Import devices √ √
|
||||
|
||||
Batch deployment √
|
||||
|
||||
Export the device √ √ √
|
||||
information
|
||||
|
||||
Edit the device √ √ √
|
||||
information
|
||||
|
||||
Assign an account to a √
|
||||
devices
|
||||
|
||||
View device √ √ √
|
||||
information
|
||||
|
||||
Diagnose devices √ √ √
|
||||
|
||||
View device √
|
||||
configuration
|
||||
|
||||
Edit device √
|
||||
configuration
|
||||
|
||||
Update device √ √ (except for MVC room system)
|
||||
configuration
|
||||
|
||||
|
||||
81 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Delete devices √ √ √
|
||||
|
||||
Set site √ √ √
|
||||
|
||||
Update firmware √ √ √
|
||||
|
||||
Update resource file √ √ √
|
||||
|
||||
Reboot √ √
|
||||
|
||||
Reset to factory √ √
|
||||
|
||||
DND/cancel DND √
|
||||
|
||||
Send information √ √ (except for MVC room system,
|
||||
RoomCast, RoomPanel)
|
||||
|
||||
Perform auto √
|
||||
provisioning
|
||||
|
||||
Update software √
|
||||
|
||||
Search devices √ √ √
|
||||
|
||||
Manage devices by a √ √ √
|
||||
group
|
||||
|
||||
Manual site setting list √ √
|
||||
|
||||
|
||||
|
||||
|
||||
82 / 82
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
AI Assistant
|
||||
Introduction
|
||||
You can describe your issues in a conversational manner or retrieve information
|
||||
related to devices, alarms, tasks, configuration statements, etc. The AI assistant
|
||||
will recognize your command intentions and help you quickly solve problems.
|
||||
|
||||
Prerequisites
|
||||
Click
|
||||
|
||||
|
||||
|
||||
to agree to the privacy agreement to start using. You can disable it on the
|
||||
enterprise side.
|
||||
AI Assistant Retrieval
|
||||
1. Log in to YMCS.
|
||||
2. On the Device Management interface, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the bottom right corner of the interface.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the scope of the AI assistant, including phone devices, room devices, and USB
|
||||
devices.
|
||||
1 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Describe your problem in the input box and send it. The AI assistant will provide you with
|
||||
the corresponding solution.
|
||||
5. Instructions, query conditions, and examples, please refer to: Instructions, Query
|
||||
Conditions, and Examples.
|
||||
|
||||
💡 TIP
|
||||
It is recommended that your description follow the format below to help the
|
||||
AI assistant analyze better:
|
||||
Help me [query] [online device]
|
||||
Help me [reboot] [online device] [at 12 A.M. every day]
|
||||
Help me [update configuration], [model name is RoomCast], [configure the
|
||||
time format to be 24-hour]
|
||||
To better tailor the AI assistant to your usage habits, you can perform any of
|
||||
the following actions on the AI assistant:
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to change the floating method of the AI assistant.
|
||||
Click Shortcut Command to quickly invoke the configuration tool.
|
||||
Click New Chat to start a new conversation and ask the AI assistant
|
||||
questions; click History dialogue to find previous search records.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Shortcut Command
|
||||
1. Log in to YMCS.
|
||||
2. On the Device Management interface, click
|
||||
|
||||
5 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the bottom right corner of the interface.
|
||||
3. Select the scope of the AI assistant, including phone devices, room devices, and USB
|
||||
devices.
|
||||
|
||||
|
||||
|
||||
|
||||
Room-Copilot
|
||||
AI Diagnosis
|
||||
1. Click shortcut command > AI Diagnosis （The room devices support AI diagnosis/
|
||||
configuration tools/unupgraded version statistics.）
|
||||
2. Describe the problem you encounter.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Configuration Tool
|
||||
1. Click the Shortcut command > Configuration Tool
|
||||
2. According to your needs, select Explain/Generate M7 Statements or Push Configuration
|
||||
|
||||
|
||||
|
||||
|
||||
7 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. The AI assistant will explain/generate the statement you need.
|
||||
|
||||
|
||||
|
||||
|
||||
8 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Unupgraded version statistics
|
||||
1. Click the Shortcut command > Unupgraded version statistics
|
||||
2. Select type and range.
|
||||
|
||||
|
||||
|
||||
|
||||
9 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone-Copilot
|
||||
Click Shortcut commands (Phone devices support configuration tool). Please
|
||||
refer to the room device-related content and follow the page instructions to
|
||||
operate.
|
||||
|
||||
10 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
USB-Copilot
|
||||
Click Shortcut commands (USB devices support configuration tool/
|
||||
Unupgraded version statistics). Please refer to the room device-related content
|
||||
and follow the page instructions to operate.
|
||||
Retrieve Configuration Statement
|
||||
💡 TIP
|
||||
In the AI assistant settings page, after enabling quick search and
|
||||
configuration tools, you can use the following quick search and
|
||||
configuration tool functions.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Log in to YMCS.
|
||||
2. When configuring text parameters for phone devices, room devices, and USB devices,
|
||||
perform one of the following operations:
|
||||
Click Configuration Generation, input the function for which you want to generate
|
||||
configuration statements, such as enabling hotspot, and press Enter to send.
|
||||
|
||||
|
||||
|
||||
|
||||
11 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Left-click and select the configuration statement text, click Explain, and the AI assistant will
|
||||
provide relevant explanations for that statement.
|
||||
|
||||
|
||||
|
||||
|
||||
AI Diagnosis
|
||||
1. Log in to YMCS.
|
||||
2. Start Diagnosing.
|
||||
3. After the diagnostics are complete, click AI Analysis.
|
||||
4. Enter the problem you are facing in the input box, such as: the speaker tracking feature of
|
||||
the device is not working, and press Enter.
|
||||
5. The AI assistant will troubleshoot for you and provide the corresponding solution.
|
||||
|
||||
|
||||
|
||||
|
||||
12 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. When performing a health check, you can use AI analysis to receive insightful
|
||||
recommendations.
|
||||
|
||||
|
||||
|
||||
|
||||
AI Search
|
||||
In the phone device list, room device list, USB device list, phone device alarm
|
||||
list, and room device alarm list, you can swiftly retrieve specific devices by using
|
||||
AI search to locate details such as device models and MAC addresses.
|
||||
|
||||
|
||||
|
||||
|
||||
13 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Instructions, Query conditions, and
|
||||
Examples
|
||||
💡 NOTE
|
||||
Sub-admins can only use Knowledge Q&A and M7 configuration queries.
|
||||
|
||||
|
||||
Knowledge Q&A
|
||||
No parameters
|
||||
Examples
|
||||
How to configure the IP address on T54W?
|
||||
Introduce MCore parameters
|
||||
What is YMCS?
|
||||
Which headset supports ANC?
|
||||
Is MVC860 compatible with Cisco?
|
||||
How to delete a device?
|
||||
|
||||
Query the non-upgraded status of devices
|
||||
|
||||
Description Value Range
|
||||
|
||||
model name of the device Enterprise-supported model
|
||||
|
||||
|
||||
14 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
The device type is host or peripheral host
|
||||
Peripheral
|
||||
|
||||
Examples
|
||||
Query the device's upgrade status
|
||||
Query M500 and MeetingBoard 65 upgrade status
|
||||
Query the peripheral device update status, model is CTP18
|
||||
|
||||
💡 NOTE
|
||||
Only room devices and personal devices support this command.
|
||||
When the device information is not specified, this command defaults to querying all host
|
||||
devices' non-upgraded status.
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query;
|
||||
they are not permitted to query the non-upgraded status of devices.
|
||||
|
||||
|
||||
Device call list query
|
||||
|
||||
Description Value Range
|
||||
|
||||
MAC address、account name Only one of the three conditions can be
|
||||
and device name queried at a time.
|
||||
|
||||
Device model Enterprise-supported model
|
||||
|
||||
Account type SIP
|
||||
SFB
|
||||
YMS
|
||||
CLOUD
|
||||
H.323
|
||||
|
||||
Call quality good
|
||||
common
|
||||
poor
|
||||
|
||||
Call Type P2P
|
||||
Conference
|
||||
Voicemail
|
||||
|
||||
15 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
The role type is Caller or Caller
|
||||
Callee Callee
|
||||
|
||||
Problem indicators Delay
|
||||
Packet Loss
|
||||
Rate Jitter
|
||||
|
||||
Examples
|
||||
Query the call quality list
|
||||
Query the device call quality with device name gty, model name SIP-T54W
|
||||
Query the device call quality with model SIP-T54W
|
||||
|
||||
💡 NOTE
|
||||
Only phone devices support this command.
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query;
|
||||
they are not permitted to query the call list of devices.
|
||||
|
||||
|
||||
Site query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Site Name /
|
||||
|
||||
Examples
|
||||
Query site
|
||||
Query the site with the site name Xiamen
|
||||
|
||||
💡 NOTE
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query; they
|
||||
are not permitted to perform site queries.
|
||||
|
||||
|
||||
Group query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Group Name /
|
||||
|
||||
Examples
|
||||
|
||||
16 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Query Yealink group
|
||||
Query device information for the group named Fujian
|
||||
Query the devices for the group named Shenzhen
|
||||
|
||||
💡 NOTE
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query; they
|
||||
are not permitted to perform group queries.
|
||||
|
||||
|
||||
Task query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Task Name /
|
||||
|
||||
Task Content Reboot
|
||||
Reset
|
||||
Send Message
|
||||
Push Resource …
|
||||
|
||||
Task Execution Status Active
|
||||
Paused
|
||||
Finished
|
||||
|
||||
Task Execution Cycle Immediately
|
||||
One-time Task /Scheduled Task
|
||||
Periodic Task (Daily)
|
||||
Periodic Task (Every Week)
|
||||
Periodic Task (Every Month)
|
||||
|
||||
Examples
|
||||
Query task with the task execution method of daily.
|
||||
Query task with a status of Active.
|
||||
Query task with task name is reboot.
|
||||
|
||||
💡 NOTE
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query;
|
||||
|
||||
|
||||
|
||||
17 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
they are not permitted to perform task queries.
|
||||
|
||||
|
||||
Task Execution Record Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Task Name /
|
||||
|
||||
Task Execution Cycle Immediately
|
||||
One-time Task/Scheduled Task
|
||||
Periodic Task (Daily)
|
||||
Periodic Task (Every Week)
|
||||
Periodic Task (Every Month)
|
||||
|
||||
Task Content Reboot or Restart
|
||||
Reset or Restore
|
||||
Send Message
|
||||
Push Resource …
|
||||
|
||||
Task Execution Status Executing
|
||||
Success
|
||||
Failure
|
||||
Partial failure
|
||||
|
||||
Examples
|
||||
Query task execution records
|
||||
Query the execution records that include Phone in the task name
|
||||
Query the execution records for tasks with an execution method of daily
|
||||
|
||||
💡 NOTE
|
||||
Only phone and conference room equipment support this command.
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query;
|
||||
they are not permitted to perform task execution record queries.
|
||||
|
||||
|
||||
Active/Resolved Alarm Query
|
||||
|
||||
|
||||
18 / 274
|
||||
@@ -0,0 +1,561 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 101-120
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 101-120 of 953
|
||||
**Chunk:** 6
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Description Value Range
|
||||
|
||||
Alarm events Bad call quality
|
||||
Registration failure
|
||||
Device offline
|
||||
DECT Manage backup…
|
||||
|
||||
MAC address usually 12 hexadecimal numbers, format may be
|
||||
01:23:45:67:89:AB; may also be af0001000817. Letters
|
||||
are case-insensitive.
|
||||
|
||||
Alarm level Common
|
||||
Primary
|
||||
Critical
|
||||
|
||||
Device name /
|
||||
|
||||
Model name Unprocessed Processing
|
||||
|
||||
Product type name SIP phone
|
||||
SC-DECT phone
|
||||
SC-DECT phone
|
||||
Teams phone…
|
||||
|
||||
Public IP address /
|
||||
|
||||
Private IP address /
|
||||
|
||||
Site name /
|
||||
|
||||
First alarm time /
|
||||
|
||||
Last alarm time /
|
||||
|
||||
Alarm process Resolved
|
||||
status Ignored
|
||||
|
||||
Alarm process time /
|
||||
|
||||
Examples
|
||||
Query active alarms
|
||||
19 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Query active alarms for devices that are offline or have registration failures
|
||||
Query the historical alarms that have been resolved
|
||||
|
||||
💡 NOTE
|
||||
Only phone and conference room equipment support this command.
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query; they
|
||||
are not permitted to perform active/history alarm queries.
|
||||
|
||||
|
||||
|
||||
|
||||
M7 Query and Generation
|
||||
M7 statements are used for device configuration in the format of Key=Value, e.g.,
|
||||
screensaver.timeout=30, lang.gui=English
|
||||
|
||||
Description Value Range
|
||||
|
||||
Device Model /
|
||||
|
||||
Examples:
|
||||
Generate config, open screensaver, model is MeetingBoard 65
|
||||
Query m7, screensaver.enable=1, model is MeetingBoard 65
|
||||
Generate config, open screensaver and set wait time to 60, model is
|
||||
Meetingboard 65
|
||||
|
||||
💡 NOTE
|
||||
This command requires specific device models to be executed, such as MeetingBoard 65 and
|
||||
SIP-T54W.
|
||||
|
||||
|
||||
Device Query/Associated Device Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
MAC address usually 12 hexadecimal numbers, format may be
|
||||
01:23:45:67:89:AB; may also be af0001000817.
|
||||
Letters are case-insensitive.
|
||||
|
||||
Device status Pending
|
||||
|
||||
|
||||
20 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Offline
|
||||
Online
|
||||
|
||||
Device name /
|
||||
|
||||
Current account Registered
|
||||
status DND
|
||||
Unregistered
|
||||
Unknown
|
||||
|
||||
Account information /
|
||||
|
||||
Public IP address /
|
||||
|
||||
Private IP address /
|
||||
|
||||
Unique SN code of /
|
||||
the device
|
||||
|
||||
VPN active status of Active
|
||||
the device Inactive
|
||||
|
||||
VPN IP of the device /
|
||||
|
||||
Site name /
|
||||
|
||||
Device model name /
|
||||
|
||||
Device firmware /
|
||||
version
|
||||
|
||||
Active status Active
|
||||
Inactive
|
||||
|
||||
Last report time of /
|
||||
the device
|
||||
|
||||
Yealink USB Connect /
|
||||
or YUC
|
||||
|
||||
Device software /
|
||||
|
||||
|
||||
21 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
name
|
||||
|
||||
Software version
|
||||
|
||||
Peripheral device All Online
|
||||
status Partially Online
|
||||
All Offline
|
||||
|
||||
Examples:
|
||||
Query device with firmware version 328.32.255.0
|
||||
Query devices with mac 249ad85a465d
|
||||
Query model Meetingboard 65 device
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing device queries or associated device queries.
|
||||
|
||||
|
||||
Reboot, Reset
|
||||
|
||||
Desc Value Range
|
||||
ript
|
||||
ion
|
||||
|
||||
Exec Immediate
|
||||
ution One-time task
|
||||
Daily
|
||||
cycle Every Week
|
||||
Every Month
|
||||
|
||||
Exec /
|
||||
ution
|
||||
time
|
||||
|
||||
Days /
|
||||
of
|
||||
exec
|
||||
|
||||
22 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
utio
|
||||
n
|
||||
|
||||
Devic The query conditions are the same as the query device, and batch
|
||||
e device execution is supported, but the scope of device execution
|
||||
info must be clearly defined, such as device status, MAC address, etc.
|
||||
rmat
|
||||
ion
|
||||
|
||||
Examples:
|
||||
Restart online devices
|
||||
Restart online devices at 4:00 AM on the 1st of every month
|
||||
Restart online devices at 12:00 PM every Wednesday and Thursday
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing restart, reset. If the execution time of a task is not specified, it will
|
||||
default to immediate execution.
|
||||
|
||||
|
||||
Device Diagnosis
|
||||
|
||||
Descripti Value Range
|
||||
on
|
||||
|
||||
Diagnostic One click export
|
||||
tool Packet capture
|
||||
Export system log
|
||||
Export configuration file
|
||||
Configuration backup
|
||||
Network detection
|
||||
Screen capture
|
||||
Remote control
|
||||
Health check
|
||||
|
||||
Device The query conditions are the same as the query device, and
|
||||
|
||||
23 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
informati batch device execution is supported, but the scope of device
|
||||
on execution must be clearly defined, such as device status, MAC
|
||||
address, etc.
|
||||
|
||||
Examples:
|
||||
Export system logs for the device with the IP address 192.168.1.1
|
||||
Perform packet capture for the device with MAC af0021017800
|
||||
|
||||
💡 NOTE
|
||||
Sub-administrators are only allowed to use the knowledge Q&A and M7 configuration query.
|
||||
|
||||
|
||||
Update Configuration
|
||||
|
||||
Description Value Range
|
||||
|
||||
Configuratio Requires device configuration modification, can be M7
|
||||
n statements, in the format of Key=Value, e.g.,
|
||||
screensaver.timeout, screensaver.timeout=30, lang.gui; or
|
||||
configuration function description, e.g., enable screensaver,
|
||||
screensaver wait time 20s
|
||||
|
||||
Device parameters same as the device query, only support single
|
||||
information device configuration modification or same model device
|
||||
configuration modification
|
||||
|
||||
Examples:
|
||||
Update device config, switch tracking mode to auto frame for MAC
|
||||
af0021017800
|
||||
Update device config, set device with MAC af0021017800 to automatically
|
||||
answer calls when headset boom is pulled out
|
||||
Update configuration with diagnose.type=123 for model SIP-T54W
|
||||
|
||||
💡 NOTE
|
||||
Sub-administrators are only allowed to use knowledge Q&A and M7 configuration query; sub-
|
||||
administrators do not support configuration updates.
|
||||
|
||||
|
||||
24 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Only for redirection
|
||||
The following features only support intention recognition, and will redirect to
|
||||
the corresponding function page after intention recognition
|
||||
Update firmware
|
||||
Add device
|
||||
Query or modify alarm notifications or alarm rules
|
||||
Enterprise Information Query
|
||||
|
||||
|
||||
|
||||
|
||||
25 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone Devices（Device）
|
||||
Add Phone Device
|
||||
Add a Device
|
||||
Introduction
|
||||
If you use the following methods to connect devices to YMCS, the devices will be
|
||||
automatically added to the corresponding device list:
|
||||
Use auto-provisioning server and specify an enterprise ID in the CFG file.
|
||||
Use DHCP Option and specify an enterprise ID in the CFG file.
|
||||
|
||||
Otherwise, you need to add or import devices to the device list manually.
|
||||
For more information, see add a single device or import a batch of devices.
|
||||
|
||||
|
||||
Import Devices
|
||||
Introduction
|
||||
If you want to add devices or modify device information quickly, you can import
|
||||
them in batches. You need to download the template, add devices in batch, or
|
||||
export the devices, edit the device information, and then import the file into
|
||||
YMCS.
|
||||
|
||||
Prerequisites
|
||||
Before importing the device, you need to pay attention to the following points:
|
||||
The maximum number of accounts that can be added varies depending on the device
|
||||
model. If the limit is exceeded, the account exceeding the limit will not be added
|
||||
successfully by default.
|
||||
If the MAC addresses filled in the template have been added to the platform, the original
|
||||
information of the devices will be updated according to the information in the template
|
||||
after import.
|
||||
If the MAC addresses filled in the template have been added to the platform but the
|
||||
account information in the template is empty, the original binding relationship will not be
|
||||
|
||||
|
||||
26 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
released.
|
||||
|
||||
For more information, see import devices.
|
||||
|
||||
|
||||
Manage Phone Devices
|
||||
View the Phone Device List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
View device information such as MAC, model number, etc.; you can click
|
||||
|
||||
|
||||
|
||||
|
||||
27 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select the fields to display.
|
||||
Click Advanced to customize the filtering criteria to find devices; you can also click Save
|
||||
Search Label to save the filtering criteria as a tag for subsequent use.
|
||||
In the Label field, click a label to view information about all devices under that label.
|
||||
In the Label field, click More > Label Management to sort, edit, and delete labels.
|
||||
|
||||
|
||||
|
||||
Operations on the Phone Device List
|
||||
Go to the Phone Device List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Import Devices
|
||||
For more information, see importing devices.
|
||||
|
||||
Export Devices
|
||||
Introduction
|
||||
You can export the basic information of devices in the list with one click.
|
||||
Procedure
|
||||
1. (Optional) In the phone device list, select the device filter to select the devices you want to
|
||||
export.
|
||||
2. Click Export.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
Go to Manual Site Setting List
|
||||
Procedure
|
||||
1. In the phone device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List. For more information, see Manual Site Setting List.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Device Information
|
||||
Procedure
|
||||
1. In the phone device list, click
|
||||
|
||||
|
||||
31 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit to edit the device information.
|
||||
|
||||
|
||||
|
||||
|
||||
View Device Details
|
||||
Procedure
|
||||
1. In the phone device list, click any device name. For more information, see phone device
|
||||
details.
|
||||
|
||||
|
||||
32 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Diagnose Devices
|
||||
Procedure
|
||||
1. In the phone device list, do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
Click Diagnosis on the right side of the desired device.
|
||||
Select devices and click Diagnosis.
|
||||
2. Quickly locate device problems by capturing packets, exporting system logs, exporting
|
||||
configuration files, etc. For more information, see diagnose devices.
|
||||
|
||||
Set Configuration Parameters
|
||||
Procedure
|
||||
1. In the phone device list, click Configuration to set configuration parameters for the device.
|
||||
|
||||
Delete Devices
|
||||
Procedure
|
||||
1. In the phone device list, do one of the following:
|
||||
|
||||
💡 NOTE
|
||||
Platform-related data (except operation logs) will be erased after deletion and cannot be
|
||||
recovered.
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
33 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the desired device.
|
||||
Select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
34 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
Update Configuration
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click Update Configuration.
|
||||
2. In the pop-up window, select the content you want to update. For more information, see
|
||||
configuration management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
|
||||
|
||||
|
||||
Update Firmware
|
||||
Procedure
|
||||
35 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. In the phone device list, select devices and click Update Firmware.
|
||||
2. In the pop-up window, select the firmware version. For more information, refer to firmware
|
||||
management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the device has an associated accessory, you can also select whether to update the firmware
|
||||
for the accessory in the pop-up window.
|
||||
|
||||
|
||||
Push Resource Files
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click Update Resource File.
|
||||
2. In the pop-up window, select the resource file. For more information, refer to other
|
||||
resource management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Set Sites
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
36 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Site Settings.
|
||||
2. Select the site to which you want the device to belong in the pop-up window and click
|
||||
Confirm.
|
||||
|
||||
💡 NOTE
|
||||
After confirmation, the device will be automatically added to the device list of the selected
|
||||
site.
|
||||
|
||||
|
||||
Move Devices to a Group
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
37 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Grouping.
|
||||
2. Select the group to which you want the device to belong in the pop-up window and click
|
||||
Confirm.
|
||||
|
||||
Reboot
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
38 / 274
|
||||
@@ -0,0 +1,395 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 121-140
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 121-140 of 953
|
||||
**Chunk:** 7
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Reboot.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the selected device is on a call, it will restart after the call ends.
|
||||
|
||||
|
||||
Restore to Factory
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
39 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Reset to Factory.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
Restoring to the factory will lose all the current personalized
|
||||
configuration of the device.
|
||||
|
||||
|
||||
Enable DND
|
||||
Introduction
|
||||
If you enable DND, the device will not ring when having incoming calls.
|
||||
Procedure
|
||||
40 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
> DND.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Cancel DND
|
||||
Introduction
|
||||
If you enable DND, the device will ring when having incoming calls.
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Cancel DND.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Send Messages to Devices
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
42 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Send Message.
|
||||
2. In the pop-up window, set the duration and the message content.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm. The
|
||||
message will pop up on the device screen.
|
||||
|
||||
Enable Auto Provisioning Now for Devices
|
||||
Introduction
|
||||
If you enable this feature, the device will get the configuration from the server
|
||||
you pre-configure.
|
||||
Procedure
|
||||
1. In the phone device list, select devices and click
|
||||
|
||||
|
||||
43 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Update Firmware.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the selected phones are on a call, the automatic update will take place after the call ends.
|
||||
|
||||
|
||||
|
||||
|
||||
View Device Details
|
||||
Go to the Details Page of the Phone Device
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
44 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the device list, click the desired device name to view the device details.
|
||||
|
||||
View Basic Device Information
|
||||
On the details page, view the model number, fireware version and other basic
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Overview
|
||||
On the details page, click Device Overview.
|
||||
|
||||
|
||||
|
||||
|
||||
45 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Hardware Information
|
||||
View the device MAC, the intranet IP, the model number, and other information.
|
||||
Click More to go to Details page.
|
||||
|
||||
|
||||
|
||||
|
||||
Active Alarms
|
||||
View active alerts for devices within the last 7 days. Click More to go to Active
|
||||
Alarms List page.
|
||||
|
||||
|
||||
|
||||
|
||||
46 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Quick Entry
|
||||
The Quick Entry bar provides you with quick actions such as Reboot, Screen
|
||||
Capture, Update Configuration, Update Firmware, Reset to Factory and so on,
|
||||
making it easy for you to perform these actions with just one click. Clicking on
|
||||
"More" will take you to the Diagnose page.
|
||||
|
||||
|
||||
|
||||
|
||||
Account Information
|
||||
View the reported account information for the device. You can log out of the
|
||||
account.
|
||||
47 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Working Status
|
||||
View the cumulative online duration of the device, calculated from the first report of the
|
||||
device. Clicking on
|
||||
|
||||
|
||||
|
||||
|
||||
48 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
allows you to view detailed information such as the start and end time of the online
|
||||
session.
|
||||
View the total duration/number of calls made by the device.
|
||||
Clicking on Refresh will refresh the current data.
|
||||
|
||||
|
||||
|
||||
|
||||
49 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Energy saving statistic
|
||||
Enable the energy-saving statistics feature in the device's local configuration settings.
|
||||
|
||||
|
||||
|
||||
|
||||
View the energy-saving statistics of devices under the selected site, as well as the
|
||||
comparison between energy-saving power consumption and general energy consumption.
|
||||
Hover to check the specific energy-saving status at the time.
|
||||
|
||||
|
||||
|
||||
|
||||
50 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
T7X/T8X supported only.
|
||||
|
||||
|
||||
Diagnose
|
||||
On the details page, click Diagnose.
|
||||
You can click Reboot, Reset to Factory, Update Configuration, Update Firmware to
|
||||
perform the corresponding actions.
|
||||
Diagnose the device using packet capture, exporting system logs, etc. For more
|
||||
information, see Device Diagnostics.
|
||||
View the diagnostic-generated files in the diagnostic history.
|
||||
|
||||
|
||||
|
||||
|
||||
51 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Configuration
|
||||
On the details page, click Config. View the current configuration of the device.
|
||||
You can click Edit to edit the device configuration parameters. For more
|
||||
information, please refer to Configuration Management.
|
||||
|
||||
|
||||
|
||||
|
||||
Associate Handsets
|
||||
1. On the details page, click Associate Handsets.
|
||||
2. （Optional）Check the device, and click updates or Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The delete operation will remove the handset device from YMCS without disconnecting the
|
||||
|
||||
|
||||
52 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
handset and the device.
|
||||
SIP-T8X/VP59/MC-DECT/SC-DECT supported.
|
||||
|
||||
|
||||
Details
|
||||
On the details page, click Details. View the details of device, such as device
|
||||
online time, handset charging status, etc. Support Retrieve again .
|
||||
|
||||
|
||||
|
||||
|
||||
Dect Signal Diagram
|
||||
1. On the details page, click Dect Signal Diagram.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
|
||||
53 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Only supports W75DM/W80DM/W90DM.
|
||||
|
||||
|
||||
|
||||
Manual Site Setting List
|
||||
Introduction
|
||||
You can move devices to the Manual Site Setting List. Devices in the list won't be
|
||||
automatically removed from their current sites (including sites with Auto Assign
|
||||
Device by IP Rule enabled). Site changes require manual resetting.
|
||||
|
||||
Move Devices to the List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
In the phone device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
54 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Site Settings. After confirmation, the devices will be automatically added to the list.
|
||||
|
||||
|
||||
|
||||
|
||||
i. In the phone device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
55 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List.
|
||||
|
||||
|
||||
|
||||
|
||||
ii. Click Move in Device, select devices and save the change.
|
||||
iii. Click Batch Move In, and select a site, YMCS will automatically add the devices at this
|
||||
site level to the list in bulk.
|
||||
|
||||
|
||||
|
||||
|
||||
56 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 Tip
|
||||
When adding devices, if you select sites other than the root site, the device will be
|
||||
automatically added to the Manual Site Setting List.
|
||||
When import devices, if you enter a site other than the root site, the device will
|
||||
automatically added to the Manual Site Setting List.
|
||||
|
||||
|
||||
Remove Devices from the List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
57 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List.
|
||||
4. In the list, click Move Out beside the desired device and confirm the action in the pop-up
|
||||
window.
|
||||
|
||||
Change Belonging Sites for Devices in the List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
58 / 274
|
||||
@@ -0,0 +1,408 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 141-160
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 141-160 of 953
|
||||
**Chunk:** 8
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List.
|
||||
4. In the list, click Site Settings beside the desired device.
|
||||
5. Select a site in the pop-up window and click Confirm.
|
||||
|
||||
Release Occupied Device
|
||||
Introduction
|
||||
For specific reasons (such as switching service providers), phone devices may be
|
||||
occupied by other enterprise platforms. YMCS provides a corresponding
|
||||
solution that allows users to remove the device from other enterprise platforms
|
||||
by entering the correct MAC address and Machine ID, thereby restoring its
|
||||
normal usage status.
|
||||
If you need to release the occupied RPS device, please refer to: RPS Devices.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
59 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
60 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Release Occupied Device.
|
||||
|
||||
|
||||
|
||||
|
||||
61 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Enter the MAC and Machine ID of the device in the pop-up window, and click Release .
|
||||
|
||||
💡 NOTE
|
||||
Limitation on the number of released occupied devices: 20 devices per day.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Devices by a Group
|
||||
Introduction
|
||||
With group management, you can assign phone devices to specific groups.
|
||||
In configuration management, you can manage device configuration based on groups.
|
||||
In task management, you can create related tasks based on groups.
|
||||
|
||||
62 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
When setting alarm notification strategies, you can send the notification to a group to
|
||||
achieve batch and convenient device management.
|
||||
|
||||
Add Groups
|
||||
Procedure
|
||||
💡 NOTE
|
||||
You can add up to 500 groups.
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Group > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the group name and description.
|
||||
4. Click Save or click Save and Add Device to add devices to this group immediately.
|
||||
|
||||
|
||||
|
||||
|
||||
63 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
64 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Add Devices
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device.
|
||||
3. Do one of the following:
|
||||
|
||||
|
||||
i. Click Group and click the desired group name.
|
||||
ii. Click Move in Device.
|
||||
iii. Select devices and click Save. The devices are added to the group.
|
||||
|
||||
|
||||
iv. Click Device List, select devices, and click
|
||||
|
||||
|
||||
|
||||
|
||||
65 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
> Grouping.
|
||||
v. Select the group to which you want the device to belong in the pop-up window and
|
||||
click Confirm.
|
||||
|
||||
Add Configuration to Devices in a Group
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Group.
|
||||
3. In the group list, click Add Configuration on the right side of the desired group.
|
||||
4. Edit the configuration information. For more information, see group configuration.
|
||||
|
||||
Add Tasks to Devices in a Group
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Group.
|
||||
3. In the group list, click Add Task on the right side of the desired group.
|
||||
4. Edit the task information. For more information, see task configuration.
|
||||
|
||||
Edit Groups
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Group.
|
||||
3. In the group list, click
|
||||
|
||||
|
||||
|
||||
|
||||
66 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit on the right side of the desired group.
|
||||
|
||||
Delete Groups
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Device > Group.
|
||||
3. In the group list, click
|
||||
|
||||
|
||||
|
||||
|
||||
67 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the desired group.
|
||||
4. Confirm the action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
68 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone Devices（Configuration
|
||||
Management）
|
||||
Introduction on Obtaining Device Configuration
|
||||
Introduction
|
||||
Through configuration management, you can easily create device configuration
|
||||
files for a single device or multiple devices based on the device's location (site)
|
||||
or group.
|
||||
There are two configuration methods. See the following detailed description:
|
||||
|
||||
Manual push Automatic push
|
||||
|
||||
Introduction For the devices connected to After the devices are
|
||||
of YMCS, they would not connected to YMCS, the
|
||||
configuration automatically obtain the devices can automatically
|
||||
obtaining: updated configuration. obtain the configuration on
|
||||
Therefore, you need to push YMCS when first powered
|
||||
the configuration to them. on or reset to factory
|
||||
settings.
|
||||
|
||||
Priority The configuration you push The device will download
|
||||
later has higher priority. the configuration in the
|
||||
following priority order:
|
||||
|
||||
|
||||
|
||||
If a conflicting
|
||||
configuration occurs, it will
|
||||
be overwritten by the
|
||||
priority order.
|
||||
|
||||
|
||||
|
||||
69 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
Group configuration does not support automatic push. You can only
|
||||
manually push the configuration to the devices.
|
||||
|
||||
|
||||
|
||||
Device Configuration
|
||||
Add Device Configuration
|
||||
Introduction
|
||||
Through device configuration, you can push configuration files to specific
|
||||
devices. Individual device configuration supports generating, uploading,
|
||||
exporting, and deleting configuration files.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration, and perform one of the following actions:
|
||||
Click Policy and click Go under the Device Configuration module.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Device Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
70 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the corresponding device information.
|
||||
Name: Enter the configuration name.
|
||||
Select Device : Select devices.
|
||||
Auto Push: If you enable Auto Push, the configuration will be automatically pushed to
|
||||
the device upon its initial power-up or factory reset.
|
||||
Description: Enter a description.
|
||||
5. Click Save and CFG.
|
||||
|
||||
|
||||
|
||||
|
||||
71 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Set parameters.
|
||||
7. Click Save to create the configuration template or click Save and Push to push the
|
||||
configuration to the device.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Configuration
|
||||
Manage Device Configuration
|
||||
Go to Configuration List
|
||||
1. Sign in to YMCS.
|
||||
2. On the Device Management Platform, click Phone Device > Configuration > Device
|
||||
|
||||
72 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
View Configuration list
|
||||
View the configuration name, the device, the model, and other information.
|
||||
Click View under the Configuration tab to view the configuration parameters.
|
||||
|
||||
Push Configuration
|
||||
For more information, see push configuration.
|
||||
|
||||
Set Parameters
|
||||
For more information, see set parameters.
|
||||
|
||||
Edit Configuration
|
||||
1. In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
73 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
|
||||
Download Configuration
|
||||
1. In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
74 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Download.
|
||||
|
||||
Delete Configuration
|
||||
1. In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
75 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete. After deletion, the related tasks will become inactive.
|
||||
|
||||
Generate Configuration
|
||||
For more information, see generate CFG files for devices.
|
||||
|
||||
Upload Configuration Files
|
||||
1. In the configuration list, click Upload to create one or multiple configuration files.
|
||||
2. Select the desired configuration files in the pop-up window and click Upload.
|
||||
|
||||
Export the Configuration Files
|
||||
1. In the configuration list, click Export.
|
||||
2. (Optional) You can export the desired configuration files by searching or filtering device
|
||||
types, models, and other fields.
|
||||
|
||||
76 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Device Configuration.
|
||||
3. In the configuration list, click Editor.
|
||||
77 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Text Editor.
|
||||
5. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via
|
||||
uploading configuration file.
|
||||
|
||||
1. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
|
||||
78 / 274
|
||||
@@ -0,0 +1,476 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 161-180
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 161-180 of 953
|
||||
**Chunk:** 9
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Prerequisites
|
||||
You can edit parameters via GUI Editor for one device model at a time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Device Configuration.
|
||||
3. In the configuration list, click Editor.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click GUI Editor.
|
||||
|
||||
|
||||
|
||||
|
||||
5. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
|
||||
79 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
set the desired parameters.
|
||||
|
||||
💡 TIP
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is online, click Obtain on the right side of the configuration to get
|
||||
the current configuration from the device.
|
||||
The green bubble on the right side of the configuration item displays the number
|
||||
of configurations that have been selected.
|
||||
|
||||
6. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
|
||||
Push Configuration
|
||||
Introduction
|
||||
For the devices connected to YMCS, they would not automatically obtain the
|
||||
updated configuration unless they are reset to the factory. Therefore, you need
|
||||
to manually push the configuration to them. After pushing the configuration to
|
||||
the device, the configuration you've set will take effect on the device.
|
||||
|
||||
Prerequisites
|
||||
The device is connected to YMCS and in online status.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Device Configuration.
|
||||
3. Click Push on the right side of the desired configuration.
|
||||
4. Click Push in the pop-up window to push the configuration to the device immediately. The
|
||||
configuration will take effect on the device and overwrite the current configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
80 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Generate Configuration Files
|
||||
Introduction
|
||||
Through generating the configuration file, it will generate backup files of the
|
||||
corresponding MAC configuration files on YMCS.
|
||||
|
||||
Prerequisites
|
||||
Offline devices do not support generating configuration files.
|
||||
Generating configuration files is not available to USB devices, the MVC, and UVC devices of
|
||||
room devices.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Device Configuration.
|
||||
3. Click Generate Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
81 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Select Device.
|
||||
5. Select the devices that you want to generate the corresponding configuration files. Click
|
||||
Generate Configuration.
|
||||
6. You can manually refresh and view the execution status in the execution records. When the
|
||||
task execution list displays "Success", it means that the configuration file has been
|
||||
generated.
|
||||
|
||||
|
||||
|
||||
Site Configuration
|
||||
Add Site Configuration
|
||||
Introduction
|
||||
Through site configuration, you can centrally push configuration files to the
|
||||
devices in the specified site, facilitating centralized management of devices
|
||||
within one or multiple sites.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration and do one of the following:
|
||||
Click Policy and click Go under the Site Configuration module.
|
||||
|
||||
|
||||
|
||||
|
||||
82 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Site Configuration.
|
||||
3. Click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the corresponding device information.
|
||||
Name: Enter the configuration name.
|
||||
Select Site: Select a site.
|
||||
|
||||
💡 NOTE
|
||||
This site configuration will apply to devices in this site and its sub-sites.
|
||||
|
||||
|
||||
Model: Select the device model.
|
||||
Auto Push : If you enable Auto Push, the configuration will be automatically pushed to
|
||||
|
||||
|
||||
83 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
the device upon its initial power-up or factory reset.
|
||||
Description: Enter a description.
|
||||
5. Click Save and CFG.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Set parameters.
|
||||
7. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
Manage Configuration
|
||||
View Configurtion List
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Site Configuration.
|
||||
3. View the configuration name, the model, the belonging site, and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
84 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Site Configuration
|
||||
Procedure
|
||||
Go to Configuration List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Site Configuration.
|
||||
|
||||
View Configuration list
|
||||
View the configuration name, the device, the model, and other information.
|
||||
Click View under the Configuration tab to view the configuration parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
Due to the configuration push priority, the configuration for sites and its sub-sites may be
|
||||
different. Select a site from the site directory and select Display current site and sub-site
|
||||
configuration/Only display current site configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
85 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Push Configuration
|
||||
For more information, see Push Configuration.
|
||||
Set Parameters
|
||||
For more information, see Set Parameters.
|
||||
Edit Configuration
|
||||
In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
86 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
|
||||
Download Configuration
|
||||
In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
87 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Download.
|
||||
|
||||
Delete Configuration
|
||||
In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
88 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete. After deletion, the related tasks will become inactive.
|
||||
|
||||
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Procedure
|
||||
|
||||
89 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Site Configuration.
|
||||
3. Click Editor on the right side of the device type you want to manage.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Text Editor.
|
||||
5. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
Configuration: Enter the corresponding configuration, which only applies to devices in
|
||||
the current site.
|
||||
|
||||
|
||||
90 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Mandatory Inheritance Configuration: Enter the corresponding configuration, which
|
||||
only applies to devices in the current site and its sub-sites.
|
||||
Superior Mandatory Inheritance Configuration: Enter the corresponding
|
||||
configuration (the configuration of the superior site), which will be enforced on devices
|
||||
in the current site.
|
||||
|
||||
💡 NOTE
|
||||
If you have configure Mandatory Inheritance Configuration, you cannot
|
||||
configure Superior Mandatory Inheritance Configuration.
|
||||
Superior Mandatory Inheritance Configuration has the highest priority of
|
||||
inheritance.
|
||||
|
||||
6. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Prerequisites
|
||||
You can edit parameters via GUI Editor for one device model at a time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Site Configuration.
|
||||
3. In the configuration list, click Editor.
|
||||
4. Click GUI Editor.
|
||||
5. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
💡 TIP
|
||||
|
||||
|
||||
|
||||
|
||||
91 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is online, click Obtain on the right side of the configuration to get the
|
||||
current configuration from the device.
|
||||
The green bubble on the right side of the configuration item displays the number of
|
||||
configuration that have been selected.
|
||||
|
||||
6. (Optional) You can click
|
||||
|
||||
|
||||
|
||||
|
||||
92 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired configuration to enable Mandatory Inheritance so the sub
|
||||
sites will be required to inherit the configuration.
|
||||
7. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
|
||||
|
||||
Push Configuration
|
||||
Introduction
|
||||
For the devices connected to YMCS, they would not automatically obtain the
|
||||
updated configuration unless they are reset to the factory. Therefore, you need
|
||||
|
||||
|
||||
93 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
to manually push the configuration to them. After pushing the configuration to
|
||||
the device, the configuration you've set will take effect on the device.
|
||||
|
||||
Prerequisites
|
||||
The device is connected to YMCS and in online status.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Site Configuration.
|
||||
3. Click Push on the right side of the desired configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Select Immediately or Scheduled Tasks to create a scheduled task and click Push.
|
||||
|
||||
|
||||
|
||||
Group Configuration
|
||||
Add Group Configuration
|
||||
Introduction
|
||||
Through group configuration, you can centrally push configuration files to the
|
||||
devices in use and remotely control a group in your group, facilitating
|
||||
centralized management of devices within the group.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
94 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Phone Device > Configuration and do one of the following:
|
||||
Click Policy and click Go under the Group Configuration module.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Group Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
95 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the corresponding device information.
|
||||
Name: Enter the configuration name.
|
||||
Group: Select a group.
|
||||
Model: Select the model.
|
||||
Description: Enter a description.
|
||||
5. Click Save and CFG.
|
||||
6. Set parameters.
|
||||
7. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
|
||||
View Configurtion List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration->Group configuration.
|
||||
3. View the configuration name, the model, the group, and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
96 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Group Configuration
|
||||
Procedure
|
||||
Go to Configuration List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration > Group Configuration.
|
||||
|
||||
View Configuration list
|
||||
|
||||
💡 TIP
|
||||
If you do not have groups, you can see manage phone devices by a group,
|
||||
manage room devices by a group to create the groups.
|
||||
|
||||
View the configuration name, the device, the model, and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
Click View under the Configuration tab to view the configuration parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
97 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Push Configuration
|
||||
For more information, see Push Configuration.
|
||||
Set Parameters
|
||||
For more information, see Set Parameters.
|
||||
Edit Configuration
|
||||
In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
98 / 274
|
||||
@@ -0,0 +1,537 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 181-200
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 181-200 of 953
|
||||
**Chunk:** 10
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
> Edit.
|
||||
|
||||
Download Configuration
|
||||
In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Download.
|
||||
|
||||
Delete Configuration
|
||||
In the configuration list, click
|
||||
|
||||
|
||||
|
||||
|
||||
99 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete. After deletion, the related tasks will become inactive.
|
||||
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
100 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Device > Configuration > Group Configuration.
|
||||
3. In the configuration list, click Editor.
|
||||
4. Click Text Editor.
|
||||
5. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
6. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Prerequisites
|
||||
You can edit parameters via GUI Editor for one device model at a time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Configuration > Group Configuration.
|
||||
3. In the configuration list, click Editor.
|
||||
4. Click GUI Editor.
|
||||
5. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
💡 TIP
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is online, click Obtain on the right side of the configuration to get the
|
||||
current configuration from the device.
|
||||
The green bubble on the right side of the configuration item displays the number of
|
||||
configuration that have been selected.
|
||||
|
||||
6. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
|
||||
Push Configuration
|
||||
|
||||
101 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction
|
||||
For the devices connected to YMCS, they would not automatically obtain the
|
||||
updated group configuration. Therefore, you need to push the configuration to
|
||||
them. After pushing the configuration to the device, the configuration you've set
|
||||
will take effect on the device.
|
||||
|
||||
Prerequisites
|
||||
The device is connected to YMCS and in online status.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Configuration > Group Configuration.
|
||||
3. Click Push on the right side of the desired configuration.
|
||||
4. Select Immediately or Scheduled Tasks to create a scheduled task and click Push.
|
||||
|
||||
|
||||
|
||||
Global Configuration
|
||||
Introduction
|
||||
Global configuration parameters will apply to all phone devices. You can use this
|
||||
template to make common and basic configuration for phone devices.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Configuration and do one of the following:
|
||||
Click Policy and click Go under the Global Configuration module.
|
||||
|
||||
|
||||
|
||||
|
||||
102 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Global Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit parameters.
|
||||
4. Make the global parameters to take effect.
|
||||
Edit parameters and click Save under the edited parameter. The device will obtain the
|
||||
edited parameters when they are powered on or reset to the factory.
|
||||
|
||||
|
||||
|
||||
|
||||
103 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Edit parameters and click Push Immediately. The parameters will be pushed to devices
|
||||
immediately.
|
||||
|
||||
|
||||
|
||||
|
||||
104 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone Device（Alarm）
|
||||
Device Authorization Status
|
||||
Introduction
|
||||
To ensure the data security of the device, YMCS needs to initiate an
|
||||
authorization request to the device when it performs one-click export, packet
|
||||
capturing, screenshot, and get call quality statistics operations on the device. The
|
||||
|
||||
authorization status is described as follows:
|
||||
|
||||
Authorizat Description
|
||||
ion Status
|
||||
|
||||
Allowed The device owner allows you to perform related diagnostic
|
||||
operations.
|
||||
|
||||
Unauthori Each time you initiate a diagnostic operation request, you need
|
||||
zed to wait for the device owner’s consent.
|
||||
|
||||
Blocked The device owner prohibits you from performing related
|
||||
diagnostic operations.
|
||||
|
||||
Authorization Requirements for Basic Operations
|
||||
The basic operation of the phone device, including rebooting, restoring factory
|
||||
settings, updating configuration, and updating firmware, does not require
|
||||
device authorization and can be used after the device is connected to YMCS.
|
||||
|
||||
Authorization Requirements for Phone Devices
|
||||
Those diagnostic operations, including one-click export, packet capturing, and
|
||||
screenshots require device authorization before they can be used. To check the
|
||||
current authorization status, please click View.
|
||||
|
||||
General Issues
|
||||
|
||||
105 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
How can I enable the one-click export/packet capturing request
|
||||
for my device?
|
||||
Please contact the device owner to perform the following operations to allow
|
||||
the one-click export/packet capturing request. The following operations are
|
||||
demonstrated using the T42U as an example. Please refer to the specific
|
||||
instructions for your actual device model, as there may be differences among
|
||||
different device models:
|
||||
1. Go to Menu on your device.
|
||||
2. Go to Security. Do one of the following:
|
||||
a. Set Packet Capture as Allowed and select Save. After that, the device allows you to
|
||||
perform one-click export or capture packets.
|
||||
|
||||
|
||||
|
||||
|
||||
a. Set Packet Capture as Unauthorized and select Save.
|
||||
|
||||
|
||||
|
||||
|
||||
b. After that, the device owner needs to allow the one-click export/packet capturing
|
||||
request each time you capture packets.
|
||||
|
||||
How do I enable screenshot/remote control requests for my
|
||||
devices?
|
||||
|
||||
106 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
For phone device, please contact the device owner to perform the following
|
||||
operations to allow the screenshot request. The following operations are
|
||||
demonstrated using the T42U as an example. Please refer to the specific
|
||||
instructions for your actual device model, as there may be differences among
|
||||
different device models:
|
||||
3. Go to Menu on your device.
|
||||
4. Go to Security. Do one of the following:
|
||||
a. Set Screenshot as Allowed and select Save. After that, the device allows you to take
|
||||
screenshots.
|
||||
|
||||
|
||||
|
||||
|
||||
a. Set Screenshot as Unauthorized and select Save.
|
||||
|
||||
|
||||
|
||||
|
||||
b. After that, the device owner needs to allow the screenshot request each time you take
|
||||
a screenshot.
|
||||
|
||||
|
||||
|
||||
Alarm Management
|
||||
Manage Alarms
|
||||
Introduction
|
||||
|
||||
107 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
When a problem occurs to the device, for example, the call failure or firmware
|
||||
update failure will be reported to YMCS. You can quickly locate the problem by
|
||||
viewing the alarm details and diagnosing the devices.
|
||||
|
||||
Procedure
|
||||
Go to Alarm List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Alarm > Alarm List.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Alarm List
|
||||
View alarm events, alarm severity, and other information in the alarm list.
|
||||
You can filter alarms based on their severity level, including common, primary, and critical
|
||||
alarms.
|
||||
Additionally, you can filter alarms based on their status, including active, resolved, and
|
||||
ignored alarms.
|
||||
|
||||
View Alarm Details
|
||||
1. Click Details on the right side of the desired alarm to view the details. The alarm details
|
||||
include the basic information (for example, the event ID, the first alarm time) and the
|
||||
detailed information (for example, the description, the troubleshooting advice.
|
||||
|
||||
Diagnose Devices that Generate Alarms
|
||||
1. In the alarm list, do any of the following:
|
||||
Click Diagnosis on the right side of the desired alarm.
|
||||
|
||||
108 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Click Details on the right side of the desired device and click Diagnose.
|
||||
1. Quickly locate device problems by capturing packets, exporting system logs, exporting
|
||||
configuration files, etc. For more information, see Device Diagnostics.
|
||||
|
||||
Activate/Solve/Ignore Alarms
|
||||
1. In the alarm list, do any of the following:
|
||||
Select alarms and click Activate/Resolve/Ignore to change the alarm status.
|
||||
Click the down arrow beside the status of the desired alarm and change the alarm status
|
||||
to Active/Resolved/Ignore.
|
||||
Click Details on the right side of the desired alarm and click Ignore/Resolve.
|
||||
|
||||
Exporting Alarm Records
|
||||
1. In the alarm list, click Export in the top-right corner.
|
||||
2. Click
|
||||
|
||||
|
||||
|
||||
|
||||
109 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
Delete Alarms
|
||||
1. In the alarm list, select alarms and click Delete. Confirm your action in the pop-up window.
|
||||
Alarm Configuration
|
||||
For more information, see alarm notifications.
|
||||
|
||||
|
||||
Alarm Notification
|
||||
Add Notification Strategies
|
||||
Introduction
|
||||
You can set alarm notification strategies based on notification recipients,
|
||||
|
||||
110 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
notification cycles, and other dimensions. When a device triggers a relevant
|
||||
alarm and the notification policy is enabled, the designated recipients will
|
||||
receive notifications via email.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Alarm > Notification > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the basic information and click Next.
|
||||
Name: Edit the notification name.
|
||||
Devices: Select All/Site/Group/Custom to specify the device range and select the
|
||||
desired devices.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the alarm content and click Next.
|
||||
111 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit the notification strategy.
|
||||
Period: Select the desired notification period.
|
||||
Recipient: Select the notification recipient. You can select the emails of the enterprise
|
||||
administrators or sub-accounts.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save.
|
||||
|
||||
|
||||
|
||||
112 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 TIP
|
||||
The notification strategy is enabled after it is added. You can disable it in the alarm
|
||||
notification list.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Notification Strategies
|
||||
Go to the Alarm Notification List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Alarm > Notification.
|
||||
|
||||
|
||||
|
||||
|
||||
View Recipients
|
||||
1. In the alarm notification list, click View under the column of Recipient to enable or disable
|
||||
the alarm.
|
||||
|
||||
Enable/Disable Notification Strategy
|
||||
1. In the alarm notification list, click
|
||||
|
||||
|
||||
|
||||
|
||||
113 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
the toggle under the column of Status to the enable or disable the alarm.
|
||||
|
||||
View Alarm Content
|
||||
1. In the alarm notification list, click View under the column of Content to view the alarm
|
||||
content.
|
||||
|
||||
114 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Edit Alarm Notification
|
||||
1. In the alarm notification list, click Edit on the right side of the desired strategy.
|
||||
|
||||
Delete Alarm Notification
|
||||
1. In the alarm notification list, click Delete on the right side of the desired strategy and
|
||||
confirm the action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
Alarm Mute
|
||||
Introduction
|
||||
You can enable the alarm mute feature for phone devices. Once enabled, the
|
||||
platform will refrain from triggering new alarms during the specified time
|
||||
period.
|
||||
For more detailed information, please refer to Alarm Mute.
|
||||
|
||||
|
||||
Alarm Rules
|
||||
Introduction
|
||||
You can configure trigger rules for various types of alarm events based on your
|
||||
enterprise's actual alarm handling practices. This includes trigger times,
|
||||
detection thresholds, and more.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Alarm > Alarm Rule.
|
||||
|
||||
|
||||
|
||||
|
||||
115 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired alarm event and click Edit.
|
||||
4. Configure alarm rules.
|
||||
|
||||
💡 NOTE
|
||||
Only the alarm rules for editing alarm events are supported. The alarm level and
|
||||
supported product categories for alarm events are system defaults and cannot be
|
||||
edited.
|
||||
Due to the nature of different alarm events, there may be differences in the support
|
||||
for rule settings. Please refer to the actual situation.
|
||||
|
||||
5. (Optional) You can reset the alarm settings to the default value.
|
||||
6. Click Save
|
||||
|
||||
|
||||
|
||||
|
||||
116 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
Supported Alarm Events and Their Supported Device
|
||||
Models
|
||||
|
||||
|
||||
Primary
|
||||
Critical
|
||||
|
||||
De Po Re Of DE Ba Ba Ha Ha Ha Ha Pe Wi Up Up Ba H
|
||||
vi or gis fli CT se se nd nd nd nd ri re gr da se n
|
||||
ce cal ter ne ma ba st set set set set ph les ad te up s
|
||||
Mo l | na ck at era s e co gr
|
||||
de qu fa re ge u us of lo st tu l mi fi nf ad u
|
||||
ls ali il so r p ab fli w at rn off c rm ig e g
|
||||
ty ur lv ba no ne po us ed lin lo wa ur fa a
|
||||
e ed ck rm we ab of e| w re at il e
|
||||
em u al r no f re po fa io ur f
|
||||
ail p rm so we il n e i
|
||||
al lv r ur fa u
|
||||
ed e il e
|
||||
em ur
|
||||
ail e
|
||||
|
||||
SI √ √ √ √ √
|
||||
P
|
||||
ph
|
||||
on
|
||||
es
|
||||
|
||||
Te √ √ √
|
||||
am
|
||||
s
|
||||
|
||||
|
||||
117 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
ph
|
||||
on
|
||||
es
|
||||
|
||||
Zo √ √ √ √
|
||||
om
|
||||
|
||||
|
||||
ph
|
||||
on
|
||||
es
|
||||
|
||||
SF √ √ √ √ √
|
||||
B
|
||||
ph
|
||||
on
|
||||
es
|
||||
|
||||
SC √ √ √ √
|
||||
-
|
||||
DE
|
||||
CT
|
||||
ph
|
||||
on
|
||||
es
|
||||
|
||||
MC √ √ √ √ √ √ √
|
||||
-
|
||||
DE
|
||||
CT
|
||||
ph
|
||||
on
|
||||
es
|
||||
|
||||
|
||||
118 / 274
|
||||
@@ -0,0 +1,654 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 201-220
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 201-220 of 953
|
||||
**Chunk:** 11
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Conditions to Trigger Alarm Events
|
||||
|
||||
Alarm Trigger Troubleshooting methods
|
||||
events conditions
|
||||
|
||||
Poor call Average call delay - Please check whether the network
|
||||
quality > 500ms; average condition is normal.
|
||||
call packet loss >
|
||||
10%;average call
|
||||
jitter > 30ms.
|
||||
|
||||
Register The device failed - Please check if the account password is
|
||||
failure to register. correct.
|
||||
- Please check whether the server
|
||||
configuration and the port information are
|
||||
correct.
|
||||
- Please check whether the server can
|
||||
respond normally.
|
||||
|
||||
Offline The device is - Please check whether the network
|
||||
offline for more connection of the device is available.
|
||||
than 5 minutes. -Check that the device is connected to the
|
||||
server.
|
||||
|
||||
DECT DECT Manager is None
|
||||
Manager unavailable.
|
||||
backup
|
||||
|
||||
Base The base is None
|
||||
backup unavailable.
|
||||
|
||||
Base Base sync failed. None
|
||||
status
|
||||
abnorma
|
||||
l
|
||||
|
||||
119 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Handset Handsets are - Make sure that the handset is within the
|
||||
offline offline. connection range.
|
||||
- Please check if the handset has enough
|
||||
power.
|
||||
|
||||
Handset When the handset - Please check if the handset power is
|
||||
low is not in charging sufficient and charge it in time.
|
||||
power mode, it will
|
||||
trigger alarms
|
||||
when the battery
|
||||
level is below 60%,
|
||||
40%, and 20%.
|
||||
|
||||
Handset The handset is out - Make sure that the handset is turned on.
|
||||
turned of power or - Please check if the handset has enough
|
||||
off remains in the off power.
|
||||
state even after
|
||||
long-pressing the
|
||||
power button.
|
||||
|
||||
Handset The handset is out - Please check if the handset is too far away
|
||||
status of signal range, the from the base.
|
||||
abnorma battery has been - Please check if the handset signal
|
||||
l disconnected, or strength is normal.
|
||||
the signal is weak. - Please check if the handset has enough
|
||||
internal.
|
||||
|
||||
Firmware Firmware upgrade - Please check whether the firmware
|
||||
upgrade failed due to matches with the device.
|
||||
failure wrong path, - Please check whether the firmware file is
|
||||
invalid rom file, corrupted.
|
||||
version mismatch - Please check whether the firmware has
|
||||
with device model, software protection.
|
||||
|
||||
120 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
same version with
|
||||
the current
|
||||
version, different
|
||||
OEM version,
|
||||
verification failure,
|
||||
etc.
|
||||
|
||||
Configura It is caused by the - Please check whether the configuration
|
||||
tion failure of file is normal and free of messy codes.
|
||||
update downloading and - Please check the configuration file format
|
||||
failure decrypting the and make sure that the file should be
|
||||
configuration file, started with #!version:1.0.0.1.
|
||||
etc.
|
||||
|
||||
Base Base firmware - Please check whether the firmware
|
||||
upgrade upgrade failed. matches with the device.
|
||||
failure - Please check whether the firmware file is
|
||||
corrupted.
|
||||
- Please check whether the firmware has
|
||||
software protection.
|
||||
|
||||
Handset Handset firmware - Please check whether the firmware
|
||||
upgrade upgrade failed. matches with the device.
|
||||
failure - Please check whether the firmware file is
|
||||
corrupted.
|
||||
- Please check whether the firmware has
|
||||
software protection.
|
||||
|
||||
Call Failed to establish - Please check if the number you are calling
|
||||
failure a call (exclude exists.
|
||||
cases where the - Please check whether the network
|
||||
call is not condition is normal.
|
||||
established due to
|
||||
|
||||
121 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
hang-up, rejection,
|
||||
no answer, etc. on
|
||||
the other end).
|
||||
|
||||
Handset Handset call - Please check if the number you are calling
|
||||
call failure. exists.
|
||||
failure - Please check whether the network
|
||||
condition is normal.
|
||||
|
||||
|
||||
|
||||
Diagnosing Devices
|
||||
|
||||
Start Diagnosing
|
||||
Diagnose a Single Device
|
||||
Prerequisites
|
||||
The device status needs to be online.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
Click Phone Device > Alarm > Diagnosis, enter the MAC/internet IP/device ID of the
|
||||
device, and click Start.
|
||||
|
||||
|
||||
|
||||
|
||||
122 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Phone Device >Device > Device List. Click Diagnosis on the right of the desired
|
||||
device.
|
||||
Click Phone Device > Alarm > Alarm List. Click Diagnosis on the right of the desired
|
||||
device.
|
||||
|
||||
|
||||
|
||||
Diagnose Multiple Device
|
||||
Prerequisites
|
||||
The device status needs to be online.
|
||||
You can diagnose up to 5 devices at the same time.
|
||||
Simultaneous diagnosis of multiple devices is unavailable to MVC, RoomCast, RoomPanel,
|
||||
and USB devices.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
a. Click Phone Device > Alarm > Diagnosis.
|
||||
b. Click Add, enter the MAC/internet IP/device ID of each device, and click Start.
|
||||
|
||||
|
||||
|
||||
|
||||
123 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Phone Device >Device > Device List. Select no more than 5 devices and click
|
||||
Diagnose.
|
||||
|
||||
|
||||
|
||||
Diagnosing Methods
|
||||
Export the Packets, Logs, and Configuration Files by One Click
|
||||
Introduction
|
||||
You can use the one-click export feature to export the packets, logs, and
|
||||
configuration files of one or multiple devices at the same time and get
|
||||
information from them to locate and analyze problems with the devices.
|
||||
|
||||
Prerequisites
|
||||
The device owner sets the one-click export request as Allowed; if the device
|
||||
owner sets the request as Unauthorized, you need to wait for the device owner's
|
||||
consent after each request you initiate.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click One-Click Export.
|
||||
2. Set parameters and click Export. For more information about packet strings, see
|
||||
commonly used packet strings.
|
||||
|
||||
💡 NOTE
|
||||
You can enter the string only when you select Customize from the drop-down menu of the
|
||||
|
||||
124 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Capture Type. Besides, if you do not enter the string, the system will capture all the data
|
||||
packets.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Diagnosis begins.
|
||||
|
||||
💡 NOTE
|
||||
If the device owner sets the one-click export request as Allowed, you can start
|
||||
immediately.
|
||||
If the device owner sets the request as Unauthorized, you need to wait for the
|
||||
device owner's consent before starting.
|
||||
|
||||
4. Please contact the device owner to reproduce the steps that cause the issue.
|
||||
5. Click Finish.
|
||||
|
||||
💡 NOTE
|
||||
If it takes more than 1 hour to capture packets, the packet capturing will be automatically
|
||||
ended.
|
||||
|
||||
|
||||
6. If the page prompts "Diagnosis completed", it is finished.
|
||||
7. You can view and download files in the history list.
|
||||
|
||||
|
||||
|
||||
|
||||
125 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
FAQ
|
||||
How can I enable the one-click export request for my device?
|
||||
For more information, see device authorization status-general issues.
|
||||
|
||||
|
||||
Capture Packets
|
||||
Introduction
|
||||
You can capture packets and reproduce test scenarios based on these data to
|
||||
locate and analyze problems with the device.
|
||||
|
||||
Prerequisites
|
||||
The device owner sets the packet capturing request as Allowed; if the device
|
||||
owner sets the packet capturing request as Asking, you need to wait for the
|
||||
device owner's consent after each request you initiate.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Packet Capture.
|
||||
2. Set parameters and click Packet Capture. For more information about packet strings, see
|
||||
commonly used packet strings.
|
||||
|
||||
💡 NOTE
|
||||
You can enter the string only when you select Customize from the drop-down menu of the
|
||||
|
||||
|
||||
126 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Capture Type. Besides, if you do not enter the string, the system will capture all the data
|
||||
packets.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Diagnosis begins.
|
||||
|
||||
💡 NOTE
|
||||
If the device owner sets the packet capturing request as Allowed, you can capture
|
||||
packets immediately.
|
||||
If the device owner sets the packet capturing request as Asking, you need to wait
|
||||
for the device owner's consent before capturing packets.
|
||||
|
||||
4. Please contact the device owner to reproduce the steps that cause the issue.
|
||||
5. Click Finish.
|
||||
|
||||
💡 NOTE
|
||||
If it takes more than 1 hour to capture packets, the packet capturing will be automatically
|
||||
ended.
|
||||
|
||||
|
||||
6. If the page prompts "Diagnosis completed", the packet is captured.
|
||||
7. You can view and download files in the history list.
|
||||
|
||||
|
||||
|
||||
|
||||
127 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
FAQ
|
||||
How do I enable the packet-capturing request for the device?
|
||||
For more information, see device authorization status-general issues.
|
||||
|
||||
|
||||
Export System Logs
|
||||
Introduction
|
||||
The system log records the system operation process and abnormal
|
||||
information. You can export the system log of the device to quickly locate the
|
||||
problems during the system operation.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Export Log.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Select the device log level, with decreasing severity levels from 0 to 6. The device will store
|
||||
the logs according to the set level. For more information about syslog levels, see syslog
|
||||
levels.
|
||||
3. Click Export, and then save the file to your local computer.
|
||||
|
||||
|
||||
|
||||
|
||||
128 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. When the export is complete, you can view and download the file in the history list.
|
||||
|
||||
|
||||
Export Configuration Files
|
||||
Introduction
|
||||
You can export CFG files or BIN files, where CFG files can choose to export static,
|
||||
non-static or all configuration files.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Export Config File.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Set parameters and click Export.
|
||||
129 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. When the export is complete, you can view and download the file in the history list.
|
||||
|
||||
|
||||
Back Up Configuration Files
|
||||
Introduction
|
||||
You can back up the configuration to prevent situations where the configuration
|
||||
files cannot be recovered due to unexpected device damage or other reasons.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Config Backup.
|
||||
2. Select Immediately or Scheduled and click Backup.
|
||||
|
||||
|
||||
|
||||
|
||||
130 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. You can view the config backup result from the Execution Record list.
|
||||
|
||||
|
||||
|
||||
|
||||
4. The backup files will be presented in the history list. You can view, push, download, or
|
||||
delete the backup files.
|
||||
|
||||
|
||||
|
||||
|
||||
Take Screenshots
|
||||
Prerequisites
|
||||
The device owner sets the screenshot request as Allowed; if the device owner
|
||||
sets the screenshot request as Asking, you need to wait for the device owner's
|
||||
consent after each screenshot request you initiate.
|
||||
|
||||
131 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Screen Capture.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click Capture.
|
||||
|
||||
💡 NOTE
|
||||
If the device owner sets the screenshot request as Allowed, you can take the device
|
||||
screenshots immediately.
|
||||
If the device owner sets the screenshot request as Asking, you need to wait for the
|
||||
device owner's consent before taking a screenshot.
|
||||
|
||||
3. After taking a screenshot, you can click Download; if you click Screen Capture again, it will
|
||||
retake a screenshot and overwrite the current one.
|
||||
|
||||
FAQ
|
||||
How do I enable screenshot requests for my device?
|
||||
For more information, see device authorization status-general issues.
|
||||
|
||||
|
||||
Diagnose Network
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Network Detection.
|
||||
|
||||
|
||||
|
||||
|
||||
132 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Select any detection method and set the parameters:
|
||||
Ping (ICMP Echo): by sending a data packet to the remote party and requesting the
|
||||
party to return a data packet of the same size, this method can identify whether those
|
||||
two devices are connected. The diagnostic results include a brief summary of the
|
||||
received packets, as well as the minimum, maximum, and average round trip times of
|
||||
the packets.
|
||||
Trace Route: this method records the route from the local device to the remote device. If
|
||||
this test succeeds, you can view the network node and the time taken from one node to
|
||||
the other to check whether or not there is network congestion.
|
||||
3. Click Detect.
|
||||
|
||||
|
||||
|
||||
Supported Diagnosing Methods
|
||||
|
||||
Diagnostic methods
|
||||
|
||||
Device One- Captu Export Export Cap Ne Conf Diagn Re
|
||||
click re the ture tw ig ose mo
|
||||
Model Export Packe Syste Config the ork bac Multip te
|
||||
s ts m uratio Scr kup le Co
|
||||
Logs n een De Devic ntr
|
||||
Files sho tec es ol
|
||||
t tio
|
||||
|
||||
133 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
n
|
||||
|
||||
SIP √ √ √ √ √ √ √ √
|
||||
phone
|
||||
s
|
||||
|
||||
Teams √ √ √ √ √ √ √ √
|
||||
phone
|
||||
s
|
||||
|
||||
Zoom √ √ √ √ √ √ √ √
|
||||
phone
|
||||
s
|
||||
|
||||
SFB √ √ √ √ √ √ √ √
|
||||
phone
|
||||
s
|
||||
|
||||
DECT √ √ √ √ √ √ √
|
||||
phone
|
||||
s
|
||||
|
||||
VCS √ √ √ √ √ √ √ √
|
||||
device
|
||||
s
|
||||
|
||||
MVC √ √ √
|
||||
device
|
||||
s
|
||||
|
||||
RoomC √ √ √ √ √
|
||||
ast
|
||||
|
||||
RoomP √ √ √ √ √
|
||||
anel
|
||||
|
||||
USB √
|
||||
|
||||
|
||||
134 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
device
|
||||
s
|
||||
|
||||
|
||||
|
||||
Frequently Used Rules for Packet Capturing
|
||||
The following are commonly used packet capture strings, which you can apply
|
||||
to device diagnosis according to the actual situation.
|
||||
|
||||
String Example Description
|
||||
|
||||
host host 10.81.36.16 Only see the incoming and outgoing
|
||||
IP traffic of a specific IP.
|
||||
|
||||
Port port 90 Only see the incoming and outgoing
|
||||
numb traffic of a specific port.
|
||||
er
|
||||
|
||||
Portra portrange 21-23 Only see the traffic belonging to a specific
|
||||
nge port range.
|
||||
value1
|
||||
-
|
||||
value
|
||||
2
|
||||
|
||||
tcp tcp port 23 and host Check who controls the phone via telnet.
|
||||
port 10.81.36.16.
|
||||
23
|
||||
and
|
||||
host
|
||||
IP
|
||||
|
||||
port / Check the packets of the requests
|
||||
80 received and the responses sent by your
|
||||
phone web user interface.
|
||||
|
||||
|
||||
135 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
net IP/ net 10.91.33.0/24 Only capture the packet from the
|
||||
mask resource IP address or the destination IP
|
||||
address.
|
||||
|
||||
src src host 10.81.36.16 Only capture the packet send by the IP
|
||||
10.81.36.16.
|
||||
|
||||
src port 80 Only capture the packet send by port 80.
|
||||
|
||||
src portrange 21-23 Only capture the packet send by the port
|
||||
number from 21 to 23.
|
||||
|
||||
dst dst host 10.81.36.16 Only capture the packet received by the
|
||||
IP 10.81.36.16.
|
||||
|
||||
dst port 80 Only capture the packet received by the
|
||||
port number 80.
|
||||
|
||||
dst portrange 21-23 Only capture the packet received by the
|
||||
port number from 21 to 23.
|
||||
|
||||
and host 10.81.33.32 and Both of the objects before or after and.
|
||||
(10.81.33.12 or This example means capturing the packet
|
||||
10.81.33.56) of IP 10.81.36.16 and IP 10.81.36.18 or
|
||||
10.81.33.56.
|
||||
|
||||
or (10.81.33.12 or Either the objects before or after or. This
|
||||
10.81.33.56) example means IP 10.81.36.18 or 10.81.
|
||||
33.56.
|
||||
|
||||
and !, ip host 10.81.36.16 Neither of them. This example means
|
||||
and and ! 10.81.36.18, ip that not capturing the packet of IP
|
||||
not host 10.81.36.16 and 10.81.36.16 and IP 10.81.36.18.
|
||||
not10.81.36.18
|
||||
|
||||
|
||||
|
||||
System Log Level
|
||||
|
||||
136 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Log Log name Description
|
||||
level
|
||||
|
||||
0 system is Emergency information. The system may no longer
|
||||
unusable be available.
|
||||
|
||||
1 action must Alert message. The service is down and may affect
|
||||
be taken the normal use of the system, requiring immediate
|
||||
immediately action.
|
||||
|
||||
2 critical More serious error messages. The service is down
|
||||
conditions and may not be repaired.
|
||||
|
||||
3 error Error message. There is a problem with the service
|
||||
conditions and it cannot be confirmed whether it is working
|
||||
properly.
|
||||
|
||||
4 warning Warning message. There may have been a problem
|
||||
conditions with the program, but it does not affect normal
|
||||
operation.
|
||||
|
||||
5 normal but Normal but important reminders. The program
|
||||
significant needs to be checked, otherwise there may be
|
||||
condition problems.
|
||||
|
||||
6 informationa General notification messages. Used to provide
|
||||
l feedback to the user on the current system status.
|
||||
|
||||
|
||||
|
||||
|
||||
137 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone Devices（Task
|
||||
Management）
|
||||
Task Executing Rules
|
||||
Task name Execution rules Phone devices
|
||||
|
||||
Reboot Reboot the selected device. √
|
||||
|
||||
Restore to factory Reset the selected devices to √
|
||||
factory.
|
||||
|
||||
Send message Send messages to selected √
|
||||
devices.
|
||||
|
||||
Auto update Make the selected perform auto √
|
||||
provisioning.
|
||||
|
||||
DND Enable DND for the registered √
|
||||
accounts on the selected
|
||||
devices.
|
||||
|
||||
Cancel DND Cancel DND for the registered √
|
||||
accounts on the selected
|
||||
devices.
|
||||
|
||||
Config backup Backup all historical √
|
||||
configuration files to prevent
|
||||
situations where device
|
||||
damage or other incidents
|
||||
result in the inability to restore
|
||||
configuration files.
|
||||
|
||||
Generate Generate the current √
|
||||
Configuration configuration files.
|
||||
|
||||
138 / 274
|
||||
@@ -0,0 +1,411 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 221-240
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 221-240 of 953
|
||||
**Chunk:** 12
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Config restore Restore current configuration to √
|
||||
historical version.
|
||||
|
||||
Push resource file Push resource files to the √
|
||||
selected devices. You can only
|
||||
push one file of the same
|
||||
resource type at a time to the
|
||||
selected devices. Only the
|
||||
resource file supported by the
|
||||
device can be pushed.
|
||||
|
||||
Push global Push global parameters to the √
|
||||
parameters selected devices.
|
||||
|
||||
Update configuration Push the custom/group/site √
|
||||
configuration you the selected
|
||||
to the selected devices.
|
||||
|
||||
Update firmware Update the selected devices’ √
|
||||
firmware. If you select the
|
||||
devices of different models,
|
||||
only the firmware applicable to
|
||||
all the devices can be updated.
|
||||
|
||||
Update software Update the selected devices’
|
||||
software. If you select the
|
||||
devices of different models,
|
||||
only the software applicable to
|
||||
all the devices can be updated.
|
||||
|
||||
|
||||
|
||||
Scheduled Tasks
|
||||
Scheduled Task Modes
|
||||
|
||||
139 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Task Description
|
||||
modes
|
||||
|
||||
Instant The task will be executed immediately.
|
||||
task
|
||||
|
||||
One- The task will be executed once at the scheduled time you set.
|
||||
time
|
||||
task
|
||||
|
||||
Recurrin The task will be executed periodically at the scheduled time you
|
||||
g task set (daily/weekly/monthly).
|
||||
|
||||
|
||||
|
||||
Add Scheduled Tasks
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Tasks > Scheduled Task.
|
||||
3. Click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Select a range and click Next.
|
||||
Devices: Select All, Site, Group,or Custom.
|
||||
|
||||
|
||||
|
||||
|
||||
140 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit the task information.
|
||||
Task Name: Enter the task name.
|
||||
Execution Mode: Select the execution mode as Immediately, One-time Task, Daily,
|
||||
Every Week, or Every Month.
|
||||
Task: Select the task type.
|
||||
6. Click Complete. The task will be executed according to your settings.
|
||||
|
||||
💡 NOTE
|
||||
If you add multiple tasks for one device, those tasks are lined up to run in order
|
||||
of their configured execution time.
|
||||
If the device is offline, the task will not be executed.
|
||||
If the task has not expired, it will be executed after the device is restored to an
|
||||
online state.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Scheduled Tasks
|
||||
Procedure
|
||||
Access the Scheduled Task List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Tasks > Scheduled Task.
|
||||
|
||||
View the Scheduled Task List
|
||||
|
||||
141 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
You can view the task type, the execution status, the execution mode, and other
|
||||
information.
|
||||
Click View under the Devices tab to see which devices are executing this task and their
|
||||
device types.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Execution Record
|
||||
1. In the scheduled task list, click Record on the right side of the desired task.
|
||||
2. The record includes the execution time and the execution status.
|
||||
3. (Optional) Click Details to view the execution result and the error reason of each executing
|
||||
device.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Scheduled Tasks
|
||||
142 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired pending or paused task and select Edit.
|
||||
|
||||
Pause Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
143 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the recurring task and select Pause.
|
||||
|
||||
Resume Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
144 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired paused task and select Continue. If the task has not
|
||||
expired, the task will be executed and completed on the time you set.
|
||||
|
||||
End Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
145 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> End.
|
||||
|
||||
💡 NOTE
|
||||
If you terminate an executing scheduled task, the task will continue to be
|
||||
executed until it completes. However, if you terminate a one-time or
|
||||
recurring task, it will no longer be executed.
|
||||
|
||||
Delete Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
146 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete to delete the finished tasks.
|
||||
|
||||
|
||||
|
||||
Executed Tasks
|
||||
View the Details of Executed Tasks
|
||||
Introduction
|
||||
With Execution Details, you can know about the execution result and the error
|
||||
reason of each device after they complete the task. In the following, we will
|
||||
introduce how to access the execution details.
|
||||
|
||||
Procedure
|
||||
|
||||
147 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Tasks.
|
||||
3. Do one of the following:
|
||||
On the Scheduled Task page, click Record > Details on the right side of the desired task.
|
||||
|
||||
|
||||
|
||||
|
||||
On the Execution Record page, click Details on the right side of the desired record.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Check the execution result and the error reason of each executing device.
|
||||
5. In the list, click Retry beside the desired device and confirm the action in the pop-up
|
||||
window. You can make this device to redo the task.
|
||||
|
||||
|
||||
|
||||
|
||||
148 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Execution Records
|
||||
Introduction
|
||||
The execution records contain detailed information about the specific time,
|
||||
content, and execution status of all tasks within the enterprise, including each
|
||||
execution of periodic tasks.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Tasks > Execution Record.
|
||||
3. Check the execution time, content, and execution status of the scheduled task.
|
||||
4. (Optional) Click Details to view the execution result and the error reason of each executing
|
||||
device.
|
||||
|
||||
|
||||
|
||||
|
||||
149 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
150 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone Devices（Data
|
||||
Statistics）
|
||||
Device Statistics
|
||||
Introduction
|
||||
You can view relevant device data under a site, including total device count,
|
||||
device status at different time points, device model statistics, firmware
|
||||
distribution statistics, device upgrade status, and other data.
|
||||
|
||||
Go to the Devices Statistics Page
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Statistics > Device Statistics.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired site from the drop-down menu. The statistics are given based on the site
|
||||
you select.
|
||||
|
||||
|
||||
|
||||
|
||||
151 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Total Count of Devices
|
||||
On the device statistics page, you can view the total number of devices in the
|
||||
selected site.
|
||||
Clicking the total number of devices will take you to the corresponding device management
|
||||
list.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Status
|
||||
On the device statistics page, you can view the status statistics based on the
|
||||
152 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
selected site within the specified time range.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to see the status in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select a period and see the status during this period.
|
||||
Hover over to see the number of devices corresponding to each device status at that time
|
||||
point.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Model Statistics
|
||||
On the device statistics page, you can view the model statistics and different
|
||||
model proportions based on the selected site.
|
||||
Click
|
||||
|
||||
153 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to select devices models.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to export statistics according to the filter you set.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
154 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
155 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to expand/collapse the device model page.
|
||||
Click the horizontal axis beside the corresponding device model to go to the device
|
||||
management page of that device model.
|
||||
|
||||
|
||||
|
||||
|
||||
156 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Firmware Statistics
|
||||
On the device statistics page, you can view the firmware distribution statistics
|
||||
and proportions based on the selected site.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select devices models.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
157 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to export statistics according to the filter you set.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
158 / 274
|
||||
@@ -0,0 +1,442 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 241-260
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 241-260 of 953
|
||||
**Chunk:** 13
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
159 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to expand/collapse the firmware distribution page.
|
||||
Click the horizontal axis beside the corresponding device model to go to the device
|
||||
management page of that device model.
|
||||
|
||||
|
||||
|
||||
|
||||
160 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Energy saving statistics
|
||||
Enable the energy-saving statistics feature in the device's web GUI.
|
||||
|
||||
|
||||
|
||||
|
||||
View the energy-saving statistics of devices under the selected site, as well as the
|
||||
comparison between energy-saving power consumption and general energy consumption.
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
161 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to view energy-saving status in units of day/week/month.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to filter and view energy-saving statistics within a specific time period.
|
||||
Hover to check the specific energy-saving status at the time.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
T7X/T8X supported only.
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm Statistics
|
||||
Introduction
|
||||
Through visual alarm statistics, you can view alarm data for devices in each site,
|
||||
including total alarms, alarm trends, alarm records, and more.
|
||||
|
||||
Go to the Alarm Statistics Page
|
||||
162 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Dashboard > Alarm Statistics.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired site from the drop-down menu. The alarm statistics are given based on
|
||||
the site you select.
|
||||
|
||||
|
||||
|
||||
|
||||
Total Number of Alarms
|
||||
On the alarm statistics page, you can view the total number of alarms and active
|
||||
|
||||
163 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
alarms based on the selected site.
|
||||
Clicking the total number of alarms or active alarm number will redirect you to the
|
||||
corresponding alarm list.
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm Trend
|
||||
On the alarm statistics page, you can view the alarm status and its trend (not
|
||||
including today) based on the selected site within the specified time range.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to see the status in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
164 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
to select a period and see the trend during this period.
|
||||
Hover over to see the number of alarms for each state at that time point.
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm List
|
||||
On the alarm statistics page, you can view the details and proportions of
|
||||
different alarm events based on the selected site.
|
||||
Click Details to view the details of this type of alarm event.
|
||||
|
||||
|
||||
|
||||
|
||||
165 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
Call Quality Statistics
|
||||
Introduction
|
||||
You can view the call data related to devices, including call quality statistics, call
|
||||
duration statistics, call record list and other data.
|
||||
The call quality parameters are described as follows:
|
||||
|
||||
Call Description
|
||||
quality
|
||||
paramete
|
||||
rs
|
||||
|
||||
Inbound Audio quality statistics between the caller and the callee.
|
||||
|
||||
Outbound Audio quality statistics between the caller and the callee.
|
||||
|
||||
Average The average difference between the maximum and minimum
|
||||
jitter (ms) delay time of the network within a certain period. It can reflect
|
||||
network latency.
|
||||
|
||||
Average Packet loss rate is the average ratio of lost packets to the total
|
||||
loss rate number of transmitted packets within a period of time.
|
||||
|
||||
Average The average value of network latency over a period of time. It
|
||||
delay (ms) can reflect network latency.
|
||||
|
||||
Max jitter The difference between the maximum and minimum network
|
||||
(ms) latency during a period of time, where the difference is the
|
||||
greatest.
|
||||
|
||||
Package The amount of packet loss during a call total.
|
||||
total loss
|
||||
|
||||
Max loss Max loss rate is the ratio of lost packets to the total number of
|
||||
rate transmitted packets within a certain period of time, where the
|
||||
ratio is the highest.
|
||||
|
||||
166 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Max delay The maximum value of network delay, reflects the quality of the
|
||||
(ms) network.
|
||||
|
||||
Average The average listen MOS value during a call, based on the PESQ
|
||||
listen MOS model. Its values can range from a low of 0.0 to a high of 5.0. A
|
||||
higher value indicates better call quality.
|
||||
|
||||
Minimum The minimum listen to MOS value during a call, based on the
|
||||
listen MOS PESQ model. Its values can range from a low of 0.0 to a high of
|
||||
5.0. A higher value indicates better call quality.
|
||||
|
||||
Average The average conversation MOS value during a call, based on the
|
||||
conversati PESQ model. Its values can range from a low of 0.0 to a high of
|
||||
on MOS 5.0. A higher value indicates better call quality.
|
||||
|
||||
Total The amount of received packets during a call.
|
||||
received
|
||||
packets
|
||||
|
||||
Load The name of the call load.
|
||||
name
|
||||
|
||||
The criteria for deciding good/fair/poor call quality are as follows:
|
||||
|
||||
|
||||
Prerequisites
|
||||
The device types that support call quality statistics are SIP phones, DECT phones, SFB
|
||||
phones, and VC room devices.
|
||||
The device has allowed you to view call quality statistics.
|
||||
|
||||
Go to the Call Statistics Page
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Statistics > Call Statistics.
|
||||
3. Select the desired site you want from the drop-down menu. The call statistics are given
|
||||
based on the site you select.
|
||||
|
||||
|
||||
|
||||
167 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Call Quality
|
||||
In the call quality list, you can view the total number of calls and call quality
|
||||
statistics based on the selected site within the specified duration.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to see the call quality in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select a period and see the call quality during this period.
|
||||
Hover over to see the call quality at that time point.
|
||||
|
||||
|
||||
|
||||
|
||||
168 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Call Duration
|
||||
In the call duration list, you can view the total call duration and daily call
|
||||
duration statistics based on the selected site within the specified duration.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to see the call the duration in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select a period and see the call duration during this period.
|
||||
Hover over to see the call duration at that time point.
|
||||
|
||||
|
||||
|
||||
|
||||
169 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Call List
|
||||
In the call list, view the call records and details of the selected site.
|
||||
Click Export to export call records based on current filtering conditions.
|
||||
Click Fresh to refresh and update the call list in real time.
|
||||
Enter MAC/account name/device name in the search box, or click Advanced to filter call
|
||||
records.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
170 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to customize the displayed call quality metrics.
|
||||
|
||||
|
||||
|
||||
|
||||
171 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Details to view the call quality details, including the call account, audio equipment,
|
||||
audio information, call quality parameters, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
172 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
FAQ
|
||||
Why can't I view the call quality statistics of the device? Why are
|
||||
only partial devices showing call quality statistics?
|
||||
You can confirm the following points again.
|
||||
4. Confirm if the device model supports call quality statistics. The supported device types are
|
||||
SIP phones, DECT phones, SFB phones, VC room devices.
|
||||
5. Confirm whether the device owner has allowed you to view call quality statistics. If
|
||||
necessary, please contact the device owner to perform the following operations to allow
|
||||
the call quality statistics request. The following operations are demonstrated using the
|
||||
T42U as an example. Please refer to the specific instructions for your actual device model,
|
||||
|
||||
173 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
as there may be differences among different device models:
|
||||
a. Go to Menu.
|
||||
b. Go to Security.
|
||||
c. Select Enabled from the drop-down menu of Call Quality Statistics and save the
|
||||
change.
|
||||
|
||||
|
||||
|
||||
|
||||
174 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Phone Devices（Resource
|
||||
Management）
|
||||
Account Management
|
||||
Add Accounts
|
||||
Introduction
|
||||
You can manage different types of products on YMCS. Different products may
|
||||
use different types of login accounts, so we divide the accounts into SIP
|
||||
accounts, H.323 accounts and SFB accounts to facilitate the management.
|
||||
After adding accounts, you can assign accounts to phone devices.
|
||||
|
||||
Prerequisites
|
||||
This feature is not applicable to room devices, USB devices, and Teams phones.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Accounts.
|
||||
3. Click Add > SIP Account/H.323 Account/SFB Account in the top-right corner.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Configure information about the account.
|
||||
|
||||
175 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
5. Click OK.
|
||||
|
||||
|
||||
|
||||
Import Accounts
|
||||
Introduction
|
||||
If you want to add multiple accounts or modify account information in batch
|
||||
quickly, you can import your accounts. You need to download the template, add
|
||||
accounts in batch, or export accounts, edit the account information, and then
|
||||
import the file into YMCS.
|
||||
After adding accounts, you can assign accounts to phone devices.
|
||||
|
||||
Prerequisites
|
||||
This feature is not applicable to room devices, USB devices, and Teams phones.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Accounts > Import.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the account type.
|
||||
4. Click Download Template. Edit the device information according to the guidance in the
|
||||
template.
|
||||
5. Save the file and upload it.
|
||||
6. Click Upload.
|
||||
|
||||
|
||||
176 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Accounts
|
||||
Procedure
|
||||
Go to the Account List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Accounts.
|
||||
|
||||
|
||||
|
||||
|
||||
177 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View the Account List
|
||||
Click the site name on the left side to view the data under this site.
|
||||
View user names, server addresses, and other information in the account list.
|
||||
Under the Bind Devices column, click View to view the devices bound to the account.
|
||||
|
||||
|
||||
|
||||
|
||||
Import Accounts
|
||||
For more information, see import accounts.
|
||||
Export Accounts
|
||||
You can export the basic information of all accounts in the list with one click.
|
||||
The exported files are classified by different account types.
|
||||
178 / 274
|
||||
@@ -0,0 +1,422 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 261-280
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 261-280 of 953
|
||||
**Chunk:** 14
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. In the account list, you can filter the exported accounts by searching or by filtering the
|
||||
account type.
|
||||
2. Click Export and select Export current list/Export all to download the account list locally.
|
||||
Export current list: Data displayed in the list after searching or selecting a site.
|
||||
Export all: All data (not searched or no sites specified) within the granted permissions.
|
||||
|
||||
Edit Account Information
|
||||
1. In the account list, click Edit to edit the account information.
|
||||
|
||||
Delete Accounts
|
||||
1. In the account list, click Delete, or select accounts and click Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
Firmware
|
||||
Add Firmware
|
||||
Introduction
|
||||
You can manage the firmware of your device in a unified way. Configure the
|
||||
relevant devices in the enterprise according to the actual situation.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Firmware > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
179 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Edit the firmware-related information.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload.
|
||||
Firmware Name: The file name will be automatically filled in as the firmware name after
|
||||
uploading the file. You can also change it manually.
|
||||
Version: After uploading the file, the installation package information will be read, and
|
||||
the version number will be filled in automatically; you can also modify it manually.
|
||||
Supported Model: Select specific product model; multiple selections are available.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to this firmware for future traceability.
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Firmware
|
||||
Procedure
|
||||
Go to the Firmware List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Firmware List
|
||||
1. Click the site name on the left side to view the data under this site.
|
||||
2. Check the firmware name, version number, and other information in the firmware list.
|
||||
|
||||
|
||||
|
||||
180 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
For more information, see push the firmware.
|
||||
Copy Firmware Link
|
||||
For more information, see copy the firmware link.
|
||||
Download Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
181 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Download to download firmware locally.
|
||||
|
||||
Edit Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
182 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
|
||||
Delete Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
183 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
Push Firmware Immediately
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
184 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
4. In the pop-up window, select Immediately and click Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
185 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
Push Firmware on Scheduled Time
|
||||
Introduction
|
||||
With scheduled tasks, you can choose to push the firmware during the non-
|
||||
working time without affecting the working process.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
|
||||
186 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
4. Select Scheduled Tasks in the pop-up window and edit the information about the
|
||||
scheduled task. Click to Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
|
||||
|
||||
Custom Templates
|
||||
Add a Template
|
||||
Introduction
|
||||
By using custom templates, you can centrally push configuration files to the
|
||||
devices you specify, facilitating centralized management.
|
||||
|
||||
Procedure
|
||||
1. Click Phone Device > Resources > Configurations > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
187 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Edit the corresponding information.
|
||||
Name: Enter the configuration name.
|
||||
Model: Select the device model.
|
||||
Site: Select the site.
|
||||
Description: Enter the description.
|
||||
3. Click Save and CFG.
|
||||
4. Set parameters.
|
||||
5. Click Save to create the configuration template or click Save and Push to immediately
|
||||
push the configuration to the device.
|
||||
|
||||
|
||||
|
||||
Manage Configuration Template
|
||||
Procedure
|
||||
Go to the Configuration Template List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Configurations.
|
||||
|
||||
|
||||
|
||||
|
||||
188 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View the Configuration Template List
|
||||
Click the site name on the left side to view the data under this site.
|
||||
View the configuration name, the device, the model, and other information.
|
||||
Click View under the Configuration tab to view the configuration parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
Push Configuration
|
||||
For more information, see push configuration template.
|
||||
Set Configuration
|
||||
For more information, see edit parameters.
|
||||
Copy Configuration Template
|
||||
189 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired configuration and click Copy to to copy the configuration.
|
||||
|
||||
💡 TIP
|
||||
You can copy the existing configuration and modify the parameters to generate a new one.
|
||||
|
||||
|
||||
Download Configuration Template
|
||||
1. In the configuration template list, click
|
||||
|
||||
|
||||
|
||||
|
||||
190 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired template and click Download.
|
||||
|
||||
Edit Configuration Template
|
||||
1. In the configuration template list, click
|
||||
|
||||
|
||||
|
||||
|
||||
191 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired template and click Edit.
|
||||
|
||||
Delete Configuration Template
|
||||
1. In the configuration template list, click
|
||||
|
||||
|
||||
|
||||
|
||||
192 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired template and click Delete.
|
||||
|
||||
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can configure the supported configuration items for the device in the
|
||||
template, and push the edited configuration parameter to the device.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Configurations.
|
||||
3. Click Editor on the right side of the configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
193 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Text Editor in the top-right corner.
|
||||
5. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save to create the configuration template or click Save and Push to push the
|
||||
configuration to the device immediately.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
194 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Prerequisites
|
||||
You can edit parameters via GUI Editor for one device model at a time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Configurations.
|
||||
3. Click Editor on the right side of the configuration.
|
||||
4. Click GUI Editor in the top-right corner.
|
||||
5. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
you can either click Select all to enable all parameters or manually select the check boxes
|
||||
of the specific parameters you want to enable.
|
||||
|
||||
💡 NOTE
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
The green bubble in the top-right corner of the configuration item displays the
|
||||
number of configurations that have been selected.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save to create the configuration template or click Save and Push to push the
|
||||
configuration to the device immediately.
|
||||
|
||||
|
||||
|
||||
Push Configuration
|
||||
Introduction
|
||||
195 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
For the devices connected to YMCS, they would not automatically obtain the
|
||||
updated configuration. Therefore, you need to push the configuration to them.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Configurations.
|
||||
3. Click Push on the right side of the configuration.
|
||||
4. Select Immediately or Scheduled Tasks to create a scheduled task and click Push.
|
||||
|
||||
|
||||
|
||||
|
||||
Other Resources
|
||||
Add Resources
|
||||
Introduction
|
||||
You can add many types of files (e.g., wallpapers, ringtones, etc.) as resource
|
||||
files and assign them to the relevant devices in your enterprise, depending on
|
||||
the actual situation.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
196 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit resource-related information.
|
||||
Resource Type: Select the resource type. For more information, see the resource type
|
||||
description.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload. The file type
|
||||
should be the same as the resource type you selected in the previous option.
|
||||
Resource Name: The file name will be automatically filled in as the resource name after
|
||||
uploading the file; you can also change it manually.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to the resource for future traceability.
|
||||
4. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
197 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
198 / 274
|
||||
@@ -0,0 +1,475 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 281-300
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 281-300 of 953
|
||||
**Chunk:** 15
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Manage Resources
|
||||
Procedure
|
||||
Go to the Resource List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Resource List
|
||||
1. Click the site name on the left side to view the data under this site.
|
||||
2. Check the resource name, the version number, and other information in the resource list.
|
||||
|
||||
|
||||
|
||||
|
||||
199 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Push Resource
|
||||
For more information, see push the resource.
|
||||
Copy Resource Link
|
||||
For more information, see copy the resource link.
|
||||
Download Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Download.
|
||||
|
||||
Edit Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
200 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Edit.
|
||||
|
||||
Delete Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
201 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Delete.
|
||||
|
||||
|
||||
|
||||
Push Resources
|
||||
Push Resources Immediately
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
3. Click Push on the right side of the desired resource.
|
||||
4. In the pop-up window, select Immediately and click Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
202 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
Push Resources on Scheduled Time
|
||||
Introduction
|
||||
With scheduled tasks, you can choose to push the resource during non-working
|
||||
time without affecting the working process.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
|
||||
203 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Click Push on the right side of the desired resource.
|
||||
4. Select Scheduled Tasks in the pop-up window and edit the information about the
|
||||
scheduled task. Click to Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
|
||||
|
||||
Copy Resource Link
|
||||
Introduction
|
||||
You can copy the resource download link and share it with others. For security
|
||||
reasons, however, only devices within the enterprise can access this
|
||||
downloading link.
|
||||
|
||||
Prerequisites
|
||||
Only devices within the enterprise can use this link to download the corresponding files.
|
||||
Direct access to this download link through your browser is not supported.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
204 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and select Copy Link.
|
||||
|
||||
|
||||
|
||||
|
||||
Introduction on Resource Type
|
||||
205 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Resource Description Supported file File size limit
|
||||
type names types
|
||||
|
||||
SkypeSetting Skype .xml/ .zip 50M
|
||||
s configuration
|
||||
|
||||
DST Daylight Saving .xml 2M
|
||||
Template Time template
|
||||
|
||||
BToE Yealink Plugin for .exe/ .msi 100M
|
||||
Zoom Rooms
|
||||
software
|
||||
|
||||
Language Language .lang 2M
|
||||
Packet packages
|
||||
|
||||
Input Input methods .txt 2M
|
||||
Method
|
||||
|
||||
Music on Customize the .wav 2M
|
||||
Hold music that would
|
||||
be heard by the
|
||||
caller who is
|
||||
placed on hold
|
||||
|
||||
Lync Phone Device licenses .dat/ .zip 50M
|
||||
License
|
||||
|
||||
Local XML contacts .xml 2M
|
||||
Directory
|
||||
File(XML)
|
||||
|
||||
Local CSV contacts .csv 2M
|
||||
Directory
|
||||
File(CSV)
|
||||
|
||||
Ringtone Ringtones .wav 8M
|
||||
|
||||
|
||||
206 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Wallpaper Wallpapers .png/ .jpg/ .bmp 5M
|
||||
|
||||
Screensaver Screensavers .png/ .jpg/ .bmp 5M
|
||||
|
||||
Logo Logos .png/ .jpg/ .bmp 2M
|
||||
|
||||
Web Item Three levels of .cfg 2M
|
||||
Level authority
|
||||
Template
|
||||
|
||||
Directory Directory template .xml 2M
|
||||
Catalog (Address Book
|
||||
Template Template)
|
||||
|
||||
Trusted Trusted certificates .pem/ .cer/ .crt/ .der 5M
|
||||
Certificates
|
||||
|
||||
Server Server certificates .pem/ .cer 5M
|
||||
Certificates
|
||||
|
||||
Replace Rule Replacement rule .xml 2M
|
||||
Template templates
|
||||
|
||||
Dial Now You can use this .xml 2M
|
||||
Template template to dial
|
||||
out calls
|
||||
immediately
|
||||
|
||||
Proxy Auto- Proxy auto .pac 2M
|
||||
config configuration files
|
||||
|
||||
Else Other .js/ .cfg/ .bin/ .pdf/ 100M
|
||||
.xml/ .tar/ .rom/ .wav
|
||||
/ .png/ .txt/ .zip/ .bo
|
||||
ot/ .dob/ .jpg/ .dat/
|
||||
.jpeg/ .bmp/ .pem/ .ce
|
||||
r/ .crt/ .der/ .cnf
|
||||
|
||||
|
||||
207 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Devices（Device）
|
||||
Add Room Devices
|
||||
Add a Device
|
||||
Introduction
|
||||
If you use the following methods to connect devices to YMCS, the devices will be
|
||||
automatically added to the corresponding device list:
|
||||
Use auto-provisioning server and specify an enterprise ID in the CFG file.
|
||||
Use DHCP Option and specify an enterprise ID in the CFG file.
|
||||
|
||||
Otherwise, you need to add the device to the device list manually.
|
||||
|
||||
Procedure
|
||||
For more information, see add a single device or import a batch of devices.
|
||||
|
||||
|
||||
|
||||
Import Devices
|
||||
Introduction
|
||||
If you want to add devices or modify device information quickly, you can import
|
||||
them in batches. You need to download the template, add devices in batch, or
|
||||
export the devices, edit the device information, and then import the file into
|
||||
YMCS.
|
||||
|
||||
Prerequisites
|
||||
Before importing the device, you need to pay attention to the following points:
|
||||
If the MAC addresses filled in the template have been added to the platform, the original
|
||||
information of the devices will be updated according to the information in the template
|
||||
after import.
|
||||
If the MAC addresses filled in the template have been added to the platform but the
|
||||
account information in the template is empty, the original binding relationship will not be
|
||||
released.
|
||||
208 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
For more information, see import devices.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Room Devices
|
||||
View the Room Device List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
View device information such as MAC, model number, etc.; you can click
|
||||
|
||||
|
||||
|
||||
|
||||
209 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select the fields to display.
|
||||
Click Advanced to customize the filtering criteria to find devices; you can also click Save
|
||||
Search Label to save the filtering criteria as a tag for subsequent use.
|
||||
In the Label field, click a label to view information about all devices under that label.
|
||||
In the Label field, click More > Label Management to sort, edit, and delete labels.
|
||||
|
||||
|
||||
|
||||
Operations on the Room Device List
|
||||
Go to the Room Device List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List to go to the room device list.
|
||||
|
||||
|
||||
|
||||
|
||||
210 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Import Devices
|
||||
For more information, see importing devices.
|
||||
|
||||
Export Devices
|
||||
Introduction
|
||||
You can export the basic information of all devices in the list with one click.
|
||||
Procedure
|
||||
1. (Optional) In the room device list, you can filter the exported devices by searching or
|
||||
filtering fields such as the model number or the belonging site.
|
||||
2. Click Export.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
211 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
Go to Manual Site Setting List
|
||||
Procedure
|
||||
1. In the room device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
212 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List. For more information, see Manual Site Setting List.
|
||||
|
||||
Edit Device Information
|
||||
Procedure
|
||||
1. In the room device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
213 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit to edit the device information.
|
||||
|
||||
View Device Details
|
||||
Procedure
|
||||
1. In the room device list, click any device name. For more information, see room device
|
||||
details.
|
||||
|
||||
Diagnose Devices
|
||||
Procedure
|
||||
1. In the room device list, click Diagnosis on the right side of the desired device.
|
||||
2. Quickly locate device problems by capturing packets, exporting system logs, exporting
|
||||
configuration files, etc. For more information, see diagnose devices.
|
||||
|
||||
214 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View Peripherals
|
||||
Procedure
|
||||
1. In the room device list, click Peripheral on the right side of the desired device. For more
|
||||
information, see room device details.
|
||||
|
||||
Delete Devices
|
||||
Procedure
|
||||
1. In the room device list, don one of the following:
|
||||
|
||||
💡 NOTE
|
||||
Platform-related data (except operation logs) will be erased after deletion and cannot be
|
||||
recovered.
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
215 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the desired device.
|
||||
Select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
216 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
Update Configuration
|
||||
Procedure
|
||||
1. In the room device list, select devices and click Update Configuration.
|
||||
2. In the pop-up window, select Yes to push the edited configuration immediately. For more
|
||||
information, see configuration management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Update Firmware
|
||||
Procedure
|
||||
1. In the room device list, select devices and click Update Firmware.
|
||||
2. In the pop-up window, select the firmware version. For more information, refer to firmware
|
||||
management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the device has an associated accessory, you can also select whether to update the firmware
|
||||
for the accessory in the pop-up window.
|
||||
|
||||
217 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Push Resource Files
|
||||
Procedure
|
||||
1. In the room device list, select devices and click Update Resource File.
|
||||
2. In the pop-up window, select the resource file. For more information, refer to other
|
||||
resource management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Set Sites
|
||||
Procedure
|
||||
1. In the room device list, select devices and click Site Settings.
|
||||
2. Select the site to which you want the device to belong in the pop-up window. Click
|
||||
Confirm.
|
||||
|
||||
💡 NOTE
|
||||
After confirmation, the device will be automatically added to the device list of the selected
|
||||
site.
|
||||
|
||||
|
||||
Move Devices to a Group
|
||||
Procedure
|
||||
1. In the room device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
218 / 274
|
||||
@@ -0,0 +1,413 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 301-320
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 301-320 of 953
|
||||
**Chunk:** 16
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Grouping.
|
||||
2. Select the group to which you want the device to belong in the pop-up window and click
|
||||
Confirm.
|
||||
|
||||
Reboot
|
||||
Procedure
|
||||
1. In the room device list, select devices and click More > Reboot.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the selected device is on a call, it will restart after the call ends.
|
||||
|
||||
|
||||
Restore to Factory
|
||||
219 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. In the room device list, select devices and click More > Reset to Factory.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 Description
|
||||
Restoring to the factory will lose all the current personalized configuration of the device.
|
||||
|
||||
|
||||
Send Messages to Devices
|
||||
Procedure
|
||||
1. In the room device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
> Send Message.
|
||||
2. In the pop-up window, set the duration and the message content.
|
||||
220 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm. The
|
||||
message will pop up on the device screen.
|
||||
|
||||
|
||||
|
||||
View Device Details
|
||||
Prerequisites
|
||||
The device status needs to be online.
|
||||
|
||||
Go to the Details Page of Room Device
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the device list, click the desired device name to view the device details.
|
||||
|
||||
Device Basic Information
|
||||
On the device details page, view the device model, MAC address, and other basic
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
221 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Overview
|
||||
On the device details page, click on Device Overview.
|
||||
|
||||
|
||||
|
||||
|
||||
Hardware Information
|
||||
Further check the device MAC, intranet IP, model, firmware version, connection
|
||||
method and other hardware information. Click More to go to Details page.
|
||||
|
||||
|
||||
|
||||
|
||||
222 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Active Alarms
|
||||
Check the active alarms of the device in the past 7 days. Click More to jump to
|
||||
Active Alarm List.
|
||||
|
||||
|
||||
|
||||
|
||||
Quick Entry
|
||||
The Quick Entry bar provides you with quick operations such as restarting,
|
||||
taking screenshots, and shutting down the computer, allowing you to quickly
|
||||
execute them with one click. Click More to jump to the Diagnosis page.
|
||||
|
||||
💡 NOTE
|
||||
For details about whether the device supports a certain operation, please
|
||||
refer to: Supported Devices for Device Management Features.
|
||||
|
||||
223 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Peripheral
|
||||
View associated/paired devices. Click View to go to Peripheral page.
|
||||
|
||||
|
||||
|
||||
|
||||
Account information
|
||||
Check the account information reported by the device.
|
||||
|
||||
|
||||
|
||||
|
||||
224 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Working Status
|
||||
To view the cumulative online time of the device since the device was first reported, click
|
||||
|
||||
|
||||
|
||||
|
||||
225 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to view the online start and end time, etc. Detailed information.
|
||||
Check how long the device has been working continuously.
|
||||
|
||||
💡 NOTE
|
||||
Android devices with multi-mode V31 and later support this function.
|
||||
Windows devices with YRC 2.35.62.255 and later versions support this
|
||||
function.
|
||||
|
||||
Check the usage of device storage space, memory, and CPU
|
||||
Click Refresh to refresh the current data.
|
||||
|
||||
|
||||
226 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View the historical change records of CPU/Memory/GPU
|
||||
View the historical change records of CPU/Memory/GPU within a specific time
|
||||
range.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Only MVC is supported; YRC needs to be upgraded to 2.35.62.255 or later
|
||||
versions.
|
||||
|
||||
|
||||
Diagnose
|
||||
In the device details interface, click Diagnose.
|
||||
|
||||
|
||||
|
||||
227 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Perform basic operations such as Reboot, shutdown, Sleep and so on.
|
||||
Use methods such as packet capture and system log export to diagnose the device. For
|
||||
more information, see Device Diagnostics.
|
||||
View related files generated by the diagnosis in the history.
|
||||
|
||||
Configuration
|
||||
In the device details interface, click Configuration.
|
||||
For more information, please refer to: Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
Peripheral
|
||||
228 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. On the device details interface, click Peripheral.
|
||||
|
||||
|
||||
|
||||
|
||||
2. (Optional) Click to switch Topology / List View to view associated devices/paired devices.
|
||||
|
||||
💡 TIP
|
||||
For MVC devices that contain multiple camera devices, you can configure
|
||||
individual cameras in a targeted manner to ensure personalized operation
|
||||
of the camera.
|
||||
1. Switch to List View.
|
||||
|
||||
2. Click Camera Settings on the right side of the camera device (needs to be
|
||||
|
||||
online).
|
||||
3. Perform relevant configurations.
|
||||
|
||||
|
||||
|
||||
|
||||
229 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Details
|
||||
On the device details interface, click Details. Check the detailed information of
|
||||
the device, such as: device online time, handle charging status, etc.; support
|
||||
manual re-acquisition.
|
||||
|
||||
|
||||
|
||||
|
||||
Manual Site Setting List
|
||||
230 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction
|
||||
You can move devices to the Manual Site Setting List. Devices in the list won't be
|
||||
automatically removed from their current sites (including sites with Auto Assign
|
||||
Device by IP Rule enabled). Site changes require manual resetting.
|
||||
|
||||
Move Devices to the List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
In the room device list, select devices and click
|
||||
|
||||
|
||||
|
||||
|
||||
231 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Site Settings. After confirmation, the devices will be automatically added to the list.
|
||||
|
||||
💡 TIP
|
||||
i. In the room device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
232 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List.
|
||||
ii. Click Move in Device, select devices and save the change.
|
||||
iii. Click Batch Move In, select a site, YMCS will automatically add the devices at this site
|
||||
level to the list in bulk.
|
||||
When adding devices, if you select sites other than the root site, the device will be
|
||||
automatically added to the Manual Site Setting List.
|
||||
When import devices, if you enter a site other than the root site, the device will
|
||||
automatically added to the Manual Site Setting List.
|
||||
|
||||
|
||||
Remove Devices from the List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
233 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List.
|
||||
4. In the list, click Move Out beside the desired device and confirm the action in the pop-up
|
||||
window.
|
||||
|
||||
Change Belonging Sites for Devices in the List
|
||||
|
||||
234 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Manual Site Setting List.
|
||||
|
||||
|
||||
235 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
4. In the list, click Site Settings beside the desired device.
|
||||
5. Select a site in the pop-up window and click Confirm.
|
||||
|
||||
|
||||
|
||||
Manage Devices by a Group
|
||||
Introduction
|
||||
With group management, you can assign room devices to specific groups.
|
||||
In configuration management, you can manage device configuration based on groups.
|
||||
In task management, you can create related tasks based on groups.
|
||||
When setting alarm notification strategies, you can send the notification to a group to
|
||||
achieve batch and convenient device management.
|
||||
|
||||
Add Groups
|
||||
Procedure
|
||||
|
||||
💡 NOTE
|
||||
You can add up to 500 groups.
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Group > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the group name and description.
|
||||
4. Click Save or click Save and Add Device to add devices to this group immediately.
|
||||
5. You can add or remove co-managers of the group, and multiple managers can be assigned
|
||||
|
||||
236 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
for joint management.
|
||||
|
||||
|
||||
|
||||
|
||||
Add Devices
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device.
|
||||
3. Do one of the following:
|
||||
i. Click Group and click the desired group name.
|
||||
ii. Click Move in Device.
|
||||
iii. Select devices and click Save. The devices are added to the group.
|
||||
i. Click Device List, select devices, and click
|
||||
|
||||
|
||||
|
||||
|
||||
237 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Grouping.
|
||||
ii. Select the group to which you want the device to belong in the pop-up window and
|
||||
click Confirm.
|
||||
|
||||
Add Configuration to Devices in a Group
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Group.
|
||||
3. In the group list, click Add Configuration on the right side of the desired group.
|
||||
4. Edit the configuration information. For more information, see group configuration.
|
||||
|
||||
Add Tasks to Devices in a Group
|
||||
|
||||
238 / 274
|
||||
@@ -0,0 +1,555 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 321-340
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 321-340 of 953
|
||||
**Chunk:** 17
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Group.
|
||||
3. In the group list, click Add Task on the right side of the desired group.
|
||||
4. Edit the task information. For more information, see task configuration.
|
||||
|
||||
Edit Groups
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Group.
|
||||
3. In the group list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit on the right side of the desired group.
|
||||
239 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Delete Groups
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Group.
|
||||
3. In the group list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the desired group.
|
||||
4. Confirm the action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
240 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Devices （Configuration
|
||||
Management）
|
||||
Introduction on Obtaining Device Configuration
|
||||
Introduction
|
||||
Through configuration management, you can easily create device configuration
|
||||
files for a single device or multiple devices based on the device's location (site)
|
||||
or group.
|
||||
There are two configuration methods. See the following detailed description:
|
||||
|
||||
Manual push Automatic push
|
||||
|
||||
Introdu The devices connected to After the devices are connected
|
||||
ction YMCS would not automatically to YMCS, the devices can
|
||||
of obtain the updated automatically obtain the
|
||||
configu configuration. Therefore, you configuration on YMCS when first
|
||||
ration need to push the powered on or reset to factory
|
||||
obtain configuration to them. settings.
|
||||
ing:
|
||||
💡 NOTE
|
||||
Except for group configuration,
|
||||
offline devices/unreported
|
||||
devices automatically obtain
|
||||
configuration after going online.
|
||||
|
||||
|
||||
Priorit The configuration you push Except for group configuration,
|
||||
y later has higher priority. the same configuration item is
|
||||
effective based on the last
|
||||
configuration.
|
||||
|
||||
|
||||
💡 NOTE
|
||||
|
||||
241 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Group configuration does not support automatic push. You can only
|
||||
manually push the configuration to the devices.
|
||||
|
||||
|
||||
|
||||
Group Configuration
|
||||
View Configurtion List
|
||||
Introduction
|
||||
You can manage the configuration of the devices in the current group in
|
||||
batches.
|
||||
|
||||
💡 TIP
|
||||
If you do not have groups, you can see manage room devices by a group
|
||||
to create the groups.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Group Config.
|
||||
3. View the device type, software type, model, the belonging site, and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Device Configuration by Group
|
||||
|
||||
242 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction
|
||||
Select the device type you want to manage for configuration, and manually
|
||||
push it to all corresponding devices in the group.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Group Config > Device Config.
|
||||
3. Click Configuration on the right side of the device type you want to manage.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set parameters.
|
||||
Click Save or click Save and Push to push the configuration to the device immediately.
|
||||
|
||||
💡 TIP
|
||||
Offline and pending devices will take effect after they go online.
|
||||
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
243 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Room Device > Configuration > Group Config > Device Config.
|
||||
3. In the configuration list, click Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Text Editor.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via upload.
|
||||
|
||||
|
||||
|
||||
|
||||
244 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Prerequisites
|
||||
You can edit parameters via GUI Editor for one device model at a time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Group Config > Device Config.
|
||||
3. In the configuration list, click Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click GUI Editor.
|
||||
|
||||
245 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
5. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is offline, it will pick up the updated configuration when it comes back
|
||||
online.
|
||||
The green bubble on the right side of the configuration item displays the number of
|
||||
configurations that have been selected.
|
||||
|
||||
6. Click Save to create the configuration or click Save and Push to push the configuration to
|
||||
the device immediately.
|
||||
|
||||
|
||||
|
||||
Manage Software Configuration (YRC) by by Group
|
||||
Introduction
|
||||
Select the device type you want to manage for configuration, and manually
|
||||
push it to all corresponding devices in the group.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Group Config > Software Config.
|
||||
3. Click Configuration on the right side of the software type you want to manage.
|
||||
|
||||
|
||||
246 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Manage the configuration according to your needs.
|
||||
5. Click Save.
|
||||
|
||||
💡 TIP
|
||||
• Offline and pending devices will take effect after they go online.
|
||||
• Only x.33.95.0 and later versions of YRC support this feature.
|
||||
|
||||
|
||||
|
||||
|
||||
Push Configuration
|
||||
Introduction
|
||||
After managing the configuration of the device/software type by group, you will
|
||||
need to manually push it to all corresponding devices in the group. Once the
|
||||
configuration is pushed to the device, the settings you have defined will be
|
||||
applied and take effect on the device.
|
||||
|
||||
Prerequisites
|
||||
The device is connected to YMCS and in online status.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Group Config > Device Config.
|
||||
3. Click Push on the right side of the desired configuration.
|
||||
4. Select Immediately or Scheduled Tasks to create a scheduled task and click Push.
|
||||
|
||||
|
||||
247 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Site Configuration
|
||||
View Configuration List
|
||||
Introduction
|
||||
The site hierarchy can be configured based on the device type. The
|
||||
configuration content from the higher level will automatically override the lower
|
||||
level, and the inherited configuration content can be directly viewed at the
|
||||
lower level.
|
||||
It is also possible for the lower level to have custom configurations, in which
|
||||
case they no longer inherit the configuration content from the higher level.
|
||||
However, the higher-level node can perform a reset operation to ensure that the
|
||||
subsequent lower levels align with the configuration content of the higher level.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Site Config.
|
||||
3. View the device type, software type, model, the belonging site, and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
248 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Device Configuration by Site
|
||||
Introduction
|
||||
Select the device type you want to manage for device configuration. Any
|
||||
configuration changes made will automatically synchronize to all devices within
|
||||
the corresponding sites.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Site Config > Device Config.
|
||||
3. Click Configuration on the right side of the device type you want to manage
|
||||
|
||||
|
||||
|
||||
|
||||
249 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
4. Set parameters.
|
||||
5. Click Save.
|
||||
|
||||
💡 TIP
|
||||
Offline and pending devices will take effect after they go online.
|
||||
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After saving the configuration, the configuration
|
||||
you've set will take effect on the devices.
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Room Devices > Configuration > Site Config.
|
||||
3. In the configuration list, click the parameter settings on the right side of any configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Click Text Editor.
|
||||
Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
|
||||
|
||||
|
||||
250 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
|
||||
|
||||
Choose the way to synchronize with Sub-sites.
|
||||
Only synchronize the content of this modification: For the sub-space, only update the
|
||||
modified/added configuration of this time and keep the original content of other
|
||||
configurations.
|
||||
Synchronize all configuration items: For the sub-space, reset them to the current
|
||||
configuration of this level.
|
||||
Select whether to override the strategy:
|
||||
Overwrite lower-level area configuration content: Based on the effective scope of the
|
||||
251 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
configuration, it will be fully applied to subordinate sites.
|
||||
Do not overwrite the configuration content of the subordinate region: For already
|
||||
configured items at the subordinate level, the parameter values will not be overwritten
|
||||
by this save.
|
||||
Click Confirm.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Prerequisites
|
||||
You can edit parameters via the GUI Editor for one device model at a time.
|
||||
Click GUI Editor.
|
||||
From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is offline, it will pick up the updated configuration when it comes
|
||||
back online.
|
||||
The green bubble on the right side of the configuration item displays the number
|
||||
of configurations that have been selected.
|
||||
|
||||
Click Save.
|
||||
Choose the way to synchronize with Sub-sites.
|
||||
Only synchronize the content of this modification: For the sub-space, only update the
|
||||
modified/added configuration of this time and keep the original content of other
|
||||
|
||||
|
||||
252 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
configurations.
|
||||
Synchronize all configuration items: For the sub-space, reset them to the current
|
||||
configuration of this level.
|
||||
Select whether to override the strategy:
|
||||
Overwrite lower-level area configuration content: Based on the effective scope of the
|
||||
configuration, it will be fully applied to subordinate sites.
|
||||
Do not overwrite the configuration content of the subordinate region: For already
|
||||
configured items at the subordinate level, the parameter values will not be overwritten
|
||||
by this save.
|
||||
Click Confirm.
|
||||
|
||||
|
||||
|
||||
Manage Software Configuration (YRC) by Site
|
||||
Introduction
|
||||
Select the software type you want to manage for software configuration. Any
|
||||
configuration changes made will automatically synchronize to all devices within
|
||||
the corresponding sites.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Site Config > Software Config.
|
||||
3. Click Configuration on the right side of the software type you want to manage
|
||||
|
||||
|
||||
|
||||
|
||||
4. Manage the configuration according to your needs.
|
||||
|
||||
253 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
5. Click Save.
|
||||
|
||||
💡 TIP
|
||||
• Offline and pending devices will take effect after they go online.
|
||||
• Only x.33.95.0 and later versions of YRC support this feature.
|
||||
|
||||
|
||||
|
||||
|
||||
Single Device Configuration
|
||||
Manage Device Configuration by Single Device
|
||||
Introduction
|
||||
You can perform device configuration for a single device.
|
||||
|
||||
💡 NOTE
|
||||
By default, a single device inherits the configuration content directly from
|
||||
its parent level.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
3. Do one of the following:
|
||||
Select the device you want to update and then click Update Device Config.
|
||||
Click Configuration on the right side of the device, and then click Device Config.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set parameters.
|
||||
|
||||
254 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
5. Click Save.
|
||||
|
||||
Set Parameters
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Device List.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select a device and enter the device configuration page.
|
||||
4. Click Text Editor.
|
||||
5. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
|
||||
|
||||
|
||||
255 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save to create the configuration.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Prerequisites
|
||||
You can edit parameters via GUI Editor for one device model at a time.
|
||||
|
||||
256 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Configuration > Device List.
|
||||
3. Select a device and enter the device configuration page.
|
||||
4. Click GUI Editor.
|
||||
5. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is offline, it will pick up the updated configuration when it comes
|
||||
back online
|
||||
The green bubble on the right side of the configuration item displays the number
|
||||
of configurations that have been selected.
|
||||
|
||||
6. Click Save to create the configuration.
|
||||
|
||||
|
||||
|
||||
Manage Microsoft Teams Rooms Settings for MVC Series
|
||||
Introduction
|
||||
The DM platform supports setting Teams configuration for MVC Series.
|
||||
|
||||
|
||||
257 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 TIP
|
||||
Supports graphical configuration and setting Teams accounts for
|
||||
multiple devices. Please refer to the text (XML file) method for
|
||||
configuration. official Microsoft documentation.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Sign in YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
3. Select the MVC device you want to set and click the Configuration on the right side of it.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Set the parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Save.
|
||||
|
||||
|
||||
258 / 274
|
||||
@@ -0,0 +1,513 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 341-360
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 341-360 of 953
|
||||
**Chunk:** 18
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
Supports configuration of: BIOS, Windows, network settings, Teams
|
||||
configuration, Teams password.
|
||||
BIOS, Windows, network settings, Teams configuration, and Teams
|
||||
password support batch configuration.
|
||||
|
||||
|
||||
|
||||
Manage Software Configuration (YRC) by Single Device
|
||||
Introduction
|
||||
You can perform software configuration for a single device.
|
||||
|
||||
💡 NOTE
|
||||
By default, a single device inherits the configuration content directly from
|
||||
its parent level.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Device > Device List.
|
||||
3. Do one of the following to configure the software of the device:
|
||||
Select the device you want to update and then click Update Software Config.
|
||||
Click Configuration on the right side of the device, and then click Software Config.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Save.
|
||||
|
||||
259 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Devices（Alarm
|
||||
Management）
|
||||
Manage Alarms
|
||||
Introduction
|
||||
When a problem occurs to the device, for example, the call failure or firmware
|
||||
update failure will be reported to YMCS. You can quickly locate the problem by
|
||||
viewing the alarm details and diagnosing the devices.
|
||||
|
||||
Procedure
|
||||
Go to Alarm List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Alarm > Alarm List.
|
||||
3. You can check the Active Alarm and Historical Alarm.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Alarm List
|
||||
View alarm events, alarm severity, and other information in the alarm list.
|
||||
You can filter alarms based on their severity level, including common, primary, and critical
|
||||
alarms.
|
||||
Additionally, you can filter alarms based on their status, including active, resolved, and
|
||||
ignored alarms.
|
||||
|
||||
260 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View Alarm Details
|
||||
1. Click Details on the right side of the desired alarm to view the details. The alarm details
|
||||
include the basic information (for example, the event ID, the first alarm time) and the
|
||||
detailed information (for example, the description, the troubleshooting advice.
|
||||
|
||||
|
||||
|
||||
|
||||
Diagnose Devices that Generate Alarms
|
||||
1. In the alarm list, do any of the following:
|
||||
Click Diagnosis on the right side of the desired alarm.
|
||||
Click Details on the right side of the desired device and click Diagnose.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Quickly locate device problems by capturing packets, exporting system logs, exporting
|
||||
configuration files, etc. For more information, see Device Diagnostics.
|
||||
Activate/Solve/Ignore Alarms
|
||||
1. In the alarm list, do any of the following:
|
||||
|
||||
261 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Select alarms and click Activate/Resolve/Ignore to change the alarm status.
|
||||
Click the down arrow beside the status of the desired alarm and change the alarm status
|
||||
to Active/Resolved/Ignore.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Details on the right side of the desired alarm and click Ignore/Resolve.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The system will automatically mark the alarm record as Ignored if it
|
||||
remains unaddressed for more than one month.
|
||||
|
||||
Exporting Alarm Records
|
||||
1. In the alarm list, click Export in the top-right corner.
|
||||
2. Click
|
||||
|
||||
262 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
|
||||
|
||||
|
||||
263 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Delete Alarms
|
||||
1. In the alarm list, select alarms and click Delete. Confirm your action in the pop-up window.
|
||||
Alarm Configuration
|
||||
For more information, see alarm notifications.
|
||||
|
||||
|
||||
Alarm Notifiation
|
||||
Add Notification Strategies
|
||||
Introduction
|
||||
You can set alarm notification strategies based on notification recipients,
|
||||
notification cycles, and other dimensions. When a device triggers a relevant
|
||||
alarm and the notification policy is enabled, the designated recipients will
|
||||
receive notifications via email.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Alarm > Notification > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
264 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the basic information and click Next.
|
||||
Name: Edit the notification name.
|
||||
Devices: Select All/Site/Group/Custom to specify the device range and select the
|
||||
desired devices.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the alarm content and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
265 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit the notification strategy.
|
||||
Period: Select the desired notification period.
|
||||
Recipient: Select the notification recipient. You can select the emails of the enterprise
|
||||
administrators or sub-accounts.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save.
|
||||
|
||||
💡 TIP
|
||||
The notification strategy is enabled after it is added. You can disable it in the alarm
|
||||
|
||||
|
||||
266 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
notification list.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Notification Strategies
|
||||
Go to the Alarm Notification List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Alarm > Notification.
|
||||
|
||||
|
||||
|
||||
|
||||
View Recipients
|
||||
1. In the alarm notification list, click View under the column of Recipient to enable or disable
|
||||
the alarm.
|
||||
|
||||
Enable/Disable Notification Strategy
|
||||
1. In the alarm notification list, click
|
||||
|
||||
|
||||
|
||||
|
||||
267 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
the toggle under the column of Status to the enable or disable the alarm.
|
||||
|
||||
View Alarm Content
|
||||
1. In the alarm notification list, click View under the column of Content to view the alarm
|
||||
content.
|
||||
|
||||
268 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Edit Alarm Notification
|
||||
1. In the alarm notification list, click Edit on the right side of the desired strategy.
|
||||
|
||||
Delete Alarm Notification
|
||||
1. In the alarm notification list, click Delete on the right side of the desired strategy and
|
||||
confirm the action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
Alarm Mute
|
||||
Introduction
|
||||
You can enable the alarm mute feature for room devices. Once enabled, the
|
||||
platform will refrain from triggering new alarms during the specified time
|
||||
period.
|
||||
For more detailed information, please refer to Alarm Mute.
|
||||
|
||||
|
||||
Alarm Rules
|
||||
Introduction
|
||||
You can configure trigger rules for various types of alarm events based on your
|
||||
enterprise's actual alarm handling practices. This includes trigger times,
|
||||
detection thresholds, and more.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Alarm > Alarm Rule.
|
||||
|
||||
|
||||
|
||||
|
||||
269 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired alarm event and click Edit.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Configure alarm rules.
|
||||
|
||||
💡 NOTE
|
||||
Only the alarm rules for editing alarm events are supported. The alarm level and
|
||||
supported product categories for alarm events are system defaults and cannot be
|
||||
edited.
|
||||
Due to the nature of different alarm events, there may be differences in the support
|
||||
for rule settings. Please refer to the actual situation.
|
||||
|
||||
5. (Optional) You can reset the alarm settings to the default value.
|
||||
6. Click Save.
|
||||
|
||||
|
||||
270 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Supported Alarm Events and Their Supported
|
||||
Device Models
|
||||
Event Severit Support Product Category
|
||||
Name y
|
||||
|
||||
Offline Critical Android Rooms System、Windows Rooms
|
||||
System、USB Video、Meeting Board、
|
||||
Presentation Devices、Digital Signage、C
|
||||
|
||||
Peripheral Critical Android Rooms System、Windows Rooms
|
||||
offline System、Meeting Board、Control System
|
||||
|
||||
Wireless mic Critical Windows Rooms System
|
||||
low power
|
||||
|
||||
Firmware Primary Android Rooms System、Meeting Board、
|
||||
upgrade Presentation Devices、Digital Signage、Control
|
||||
failure System
|
||||
|
||||
Configuratio Primary Android Rooms System、Meeting Board、
|
||||
n update Presentation Devices、Digital Signage、Control
|
||||
|
||||
|
||||
271 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
failure System
|
||||
|
||||
Peripheral Primary Control System
|
||||
firmware
|
||||
upgrade
|
||||
failure
|
||||
|
||||
Sensor Primary Digital Signage
|
||||
upgrade
|
||||
failure
|
||||
|
||||
Sensor low Primary Digital Signage
|
||||
power
|
||||
|
||||
Network Primary Android Rooms System、Meeting Board
|
||||
disconnecti
|
||||
on
|
||||
|
||||
|
||||
|
||||
Conditions to Trigger Alarm Events
|
||||
💡 TIP
|
||||
You can customize the triggering time/threshold for each event in Alarm
|
||||
Rules.
|
||||
|
||||
|
||||
|
||||
Alarm Trigger Troubleshooting methods
|
||||
events conditions
|
||||
|
||||
Offline The device is - Please check whether the network
|
||||
offline for more connection of the device is available.
|
||||
than 5 minutes. -Check that the device is connected to the
|
||||
server.
|
||||
|
||||
Wireless The power of - Please check whether the power of the
|
||||
|
||||
|
||||
272 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
mic low the wireless wireless microphone is sufficient and
|
||||
power microphone is charge it in time.
|
||||
below 10%.
|
||||
|
||||
Firmware Firmware - Please check whether the firmware
|
||||
update upgrade failed matches with the device.
|
||||
failure due to wrong - Please check whether the firmware file is
|
||||
path, invalid corrupted.
|
||||
rom file, - Please check whether the firmware has
|
||||
version software protection.
|
||||
mismatch with
|
||||
device model,
|
||||
same version
|
||||
with the
|
||||
current version,
|
||||
different OEM
|
||||
version,
|
||||
verification
|
||||
failure, etc.
|
||||
|
||||
Configuratio It is caused by - Please check whether the configuration
|
||||
n update the failure of file is normal and free of messy codes.
|
||||
failure downloading - Please check the configuration file format
|
||||
and decrypting and make sure that the file should be
|
||||
the started with #!version:1.0.0.1.
|
||||
configuration
|
||||
file, etc.
|
||||
|
||||
Sensor low Sensor power is - Please check if the sensor power is
|
||||
power below 10%. sufficient and charge it in time.
|
||||
|
||||
Sensor Sensor upgrade - Please check whether the firmware
|
||||
upgrade failed. matches with the device.
|
||||
|
||||
273 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
failure - Please check whether the firmware file is
|
||||
corrupted.
|
||||
- Please check whether the firmware has
|
||||
software protection.
|
||||
|
||||
Peripheral Peripherals are - Make sure that the peripheral is within the
|
||||
offline offline. connection range.
|
||||
- Please check if the Peripheral has enough
|
||||
power.
|
||||
|
||||
Peripheral Peripheral - Please check whether the peripheral
|
||||
firmware firmware matches with the device.
|
||||
upgrade upgrade failed. - Please check whether the firmware file is
|
||||
failure corrupted.
|
||||
- Please check whether the firmware has
|
||||
software protection.
|
||||
|
||||
Network Network is - Please check if the network connection of
|
||||
disconnecti disconnected the corresponding terminal device is
|
||||
on for more than a normal.
|
||||
certain period
|
||||
of time.
|
||||
|
||||
|
||||
|
||||
|
||||
274 / 274
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device (Diagnosis)
|
||||
Device Authorization Status
|
||||
Introduction
|
||||
To ensure the data security of the device, YMCS needs to initiate an
|
||||
authorization request to the device when it performs one-click export, packet
|
||||
capturing, screenshot, and remote control operations on the device. The
|
||||
|
||||
authorization status is described as follows:
|
||||
|
||||
Authorizatio Description
|
||||
n Status
|
||||
|
||||
Allowed The device owner allows you to perform related diagnostic
|
||||
operations.
|
||||
|
||||
Unauthorize Each time you initiate a diagnostic operation request, you
|
||||
d need to wait for the device owner’s consent.
|
||||
|
||||
Blocked The device owner prohibits you from performing related
|
||||
diagnostic operations.
|
||||
|
||||
Authorization Requirements for MVC/MeetingBoard/
|
||||
MeetingBar/DeskVision A24
|
||||
Those diagnostic operations, including screenshots and remote control, require
|
||||
MVC/MeetingBoard/MeetingBar/DeskVision A24 authorization before they can
|
||||
be used. To check the current authorization status, please click View.
|
||||
|
||||
|
||||
|
||||
|
||||
1 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
General Issues
|
||||
How do I enable screenshot/remote control requests for my
|
||||
devices?
|
||||
For MVC room devices, please contact the device owner to perform the following
|
||||
operations to allow the screenshot/remote control request:
|
||||
1. Open Yealink RoomConnect software and click
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> DM Server Settings.
|
||||
2. Enable Authorize Remote Screenshot/Authorize Remote Desktop.
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
For MeetingBoard/MeetingBar/DeskVision A24, please contact the device owner
|
||||
to perform the following operations to allow the screenshot/remote control
|
||||
request:
|
||||
3. Enter Device Settings.
|
||||
4. Click Yealink Cloud Service > Yealink Device Management Platform.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Enable Remote Diagnostic.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 197
|
||||
@@ -0,0 +1,594 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 361-380
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 361-380 of 953
|
||||
**Chunk:** 19
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Start Diagnosing
|
||||
Prerequisites
|
||||
The device status needs to be online.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following to diagnose the device.
|
||||
Click Room Device > Alarm > Alarm List, and click Diagnosis on the right of the desired
|
||||
device.
|
||||
|
||||
|
||||
|
||||
|
||||
5 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Click Room Device > Device > Device List, and click Diagnosis on the right of the
|
||||
desired device.
|
||||
|
||||
|
||||
|
||||
Diagnosing Methods
|
||||
Export the Packets, Logs, and Configuration Files by One
|
||||
Click
|
||||
Introduction
|
||||
You can use the one-click export feature to export the packets, logs, and
|
||||
configuration files of one or multiple devices at the same time and get
|
||||
information from them to locate and analyze problems with the devices.
|
||||
|
||||
Prerequisites
|
||||
The device owner sets the one-click export request as Allowed; if the device
|
||||
owner sets the request as Unauthorized, you need to wait for the device owner's
|
||||
consent after each request you initiate.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click One-Click Export.
|
||||
2. Set parameters and click Export. For more information about packet strings, see
|
||||
commonly used packet strings.
|
||||
|
||||
💡 NOTE
|
||||
You can enter the string only when you select Customize from the drop-down menu of the
|
||||
Capture Type. Besides, if you do not enter the string, the system will capture all the data
|
||||
packets.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Diagnosis begins.
|
||||
|
||||
💡 NOTE
|
||||
If the device owner sets the one-click export request as Allowed, you can start
|
||||
immediately.
|
||||
If the device owner sets the request as Unauthorized, you need to wait for the
|
||||
device owner's consent before starting.
|
||||
|
||||
4. Please contact the device owner to reproduce the steps that cause the issue.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Finish.
|
||||
|
||||
💡 NOTE
|
||||
If it takes more than 1 hour to capture packets, the packet capturing will be automatically
|
||||
|
||||
7 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
ended.
|
||||
|
||||
|
||||
6. If the page prompts "Diagnosis completed", it is finished.
|
||||
7. You can view and download files in the history list.
|
||||
|
||||
FAQ
|
||||
How can I enable the one-click export request for my device?
|
||||
For more information, see device authorization status-general issues.
|
||||
|
||||
|
||||
Capture Packets
|
||||
Introduction
|
||||
You can capture packets and reproduce test scenarios based on these data to
|
||||
locate and analyze problems with the device.
|
||||
|
||||
Prerequisites
|
||||
The device owner sets the packet capturing request as Allowed; if the device
|
||||
owner sets the packet capturing request as Asking, you need to wait for the
|
||||
device owner's consent after each request you initiate.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Packet Capture.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Set parameters and click Packet Capture. For more information about packet strings, see
|
||||
|
||||
|
||||
8 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
commonly used packet strings.
|
||||
|
||||
💡 NOTE
|
||||
You can enter the string only when you select Customize from the drop-down menu of the
|
||||
Capture Type. Besides, if you do not enter the string, the system will capture all the data
|
||||
packets.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Diagnosis begins.
|
||||
|
||||
💡 NOTE
|
||||
If the device owner sets the packet capturing request as Allowed, you can capture
|
||||
packets immediately.
|
||||
If the device owner sets the packet capturing request as Asking, you need to wait
|
||||
for the device owner's consent before capturing packets.
|
||||
|
||||
4. Please contact the device owner to reproduce the steps that cause the issue.
|
||||
5. Click Finish.
|
||||
|
||||
💡 NOTE
|
||||
If it takes more than 1 hour to capture packets, the packet capturing will be automatically
|
||||
ended.
|
||||
|
||||
|
||||
6. If the page prompts "Diagnosis completed", the packet is captured.
|
||||
7. You can view and download files in the history list.
|
||||
|
||||
FAQ
|
||||
How do I enable the packet-capturing request for the device?
|
||||
9 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
For more information, see device authorization status-general issues.
|
||||
|
||||
|
||||
Export System Logs
|
||||
Introduction
|
||||
The system log records the system operation process and abnormal
|
||||
information. You can export the system log of the device to quickly locate the
|
||||
problems during the system operation.
|
||||
|
||||
|
||||
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Export Log.
|
||||
2. Select the device log level, with decreasing severity levels from 0 to 6. The device will store
|
||||
the logs according to the set level. For more information about syslog levels, see syslog
|
||||
levels.
|
||||
3. Click Export, and then save the file to your local computer.
|
||||
4. When the export is complete, you can view and download the file in the history list.
|
||||
|
||||
|
||||
Export Configuration Files
|
||||
Introduction
|
||||
You can export CFG files or BIN files, where CFG files can choose to export static,
|
||||
non-static or all configuration files.
|
||||
|
||||
|
||||
10 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Export Config File.
|
||||
2. Set parameters and click Export.
|
||||
|
||||
|
||||
|
||||
|
||||
3. When the export is complete, you can view and download the file in the history list.
|
||||
|
||||
|
||||
|
||||
Back Up Configuration Files
|
||||
Introduction
|
||||
You can back up the configuration to prevent situations where the configuration
|
||||
files cannot be recovered due to unexpected device damage or other reasons.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Config Backup.
|
||||
2. Select Immediately or Scheduled and click Backup.
|
||||
|
||||
|
||||
|
||||
|
||||
11 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. You can view the config backup result from the Execution Record list.
|
||||
4. The backup files will be presented in the history list. You can view, push, download, or
|
||||
delete the backup files.
|
||||
|
||||
|
||||
|
||||
Take Screenshots
|
||||
Prerequisites
|
||||
The device owner sets the screenshot request as Allowed; if the device owner
|
||||
sets the screenshot request as Asking, you need to wait for the device owner's
|
||||
consent after each screenshot request you initiate.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Screen Capture.
|
||||
2. Click Capture.
|
||||
|
||||
💡 NOTE
|
||||
If the device owner sets the screenshot request as Allowed, you can take the device
|
||||
screenshots immediately.
|
||||
If the device owner sets the screenshot request as Asking, you need to wait for the
|
||||
device owner's consent before taking a screenshot.
|
||||
|
||||
3. After taking a screenshot, you can click Download; if you click Screen Capture again, it will
|
||||
retake a screenshot and overwrite the current one.
|
||||
|
||||
FAQ
|
||||
12 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
How do I enable screenshot requests for my device?
|
||||
For more information, see device authorization status-general issues.
|
||||
|
||||
|
||||
Diagnose Network
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Network Detection.
|
||||
2. Select any detection method and set the parameters:
|
||||
Ping (ICMP Echo): by sending a data packet to the remote party and requesting the
|
||||
party to return a data packet of the same size, this method can identify whether those
|
||||
two devices are connected. The diagnostic results include a brief summary of the
|
||||
received packets, as well as the minimum, maximum, and average round trip times of
|
||||
the packets.
|
||||
Trace Route: this method records the route from the local device to the remote device. If
|
||||
this test succeeds, you can view the network node and the time taken from one node to
|
||||
the other to check whether or not there is network congestion.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Detect.
|
||||
|
||||
|
||||
|
||||
Remote Control
|
||||
Introduction
|
||||
You can remotely operate the touch screen of the devices and troubleshoot
|
||||
problems through remote control. Due to data security, YMCS only accesses data
|
||||
|
||||
13 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
on the touch screen and does not store it during remote control.
|
||||
|
||||
Prerequisites
|
||||
You have assigned the pro license to the meeting room.
|
||||
Do one of the following:
|
||||
If your enterprise is located in EU region, please refer to the network requirements of
|
||||
remote control under EU region and open the relevant domain name and port;
|
||||
If your enterprise is located in US region, please refer to the network requirements of
|
||||
remote control under US region and open the relevant domain name and port.
|
||||
If your enterprise is located in AU region, please refer to the network requirements of
|
||||
remote control under AU region and open the relevant domain name and port.
|
||||
If your enterprise is located in UAE region, please refer to the network requirements of
|
||||
remote control under UAE region and open the relevant domain name and port.
|
||||
Supported devices: MVC Series/MeetingBoard/MeetingBar/MeetingEye/DeskVision A24.
|
||||
For MeetingBoard/MeetingBar/MeetingEye, you can simultaneously remote control the
|
||||
host device and its touch screen (requires independent connecting to YMCS).
|
||||
For MVC Series/DeskVision A24, only a single device can be remotely controlled at a time.
|
||||
The device status needs to be online.
|
||||
The remote control feature is enabled.
|
||||
The device owner allows you to remote control. For more information, see device
|
||||
authorization status-general issues.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnostics page, click Remote Control.
|
||||
|
||||
|
||||
|
||||
|
||||
14 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. If the enterprise has assigned the remote control license and the device has not yet been
|
||||
assigned to a conference room, you need to assign it first before further using the remote
|
||||
control function.
|
||||
Create a New Room with Pro License: Create a new room and edit related information
|
||||
such as name, location, capacity, etc. The pro license will be automatically assigned to
|
||||
the created room.
|
||||
Select a Existing Room: Select an existing room. If the room does not have a pro license,
|
||||
a new license will be automatically assigned to it.
|
||||
|
||||
|
||||
|
||||
|
||||
15 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. (Optional) If the device has peripheral devices, you can choose to control only the device or
|
||||
control the device and its peripheral devices.
|
||||
4. Wait for the terminal to respond, and then start the remote control.
|
||||
|
||||
💡 NOTE
|
||||
For Android devices, you need to enter the local administrator password.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Please refer to the user's guide of each device to operate the device and
|
||||
troubleshoot the problem.
|
||||
|
||||
💡 TIP
|
||||
Click End in the upper right corner of the interface to end control; in the left
|
||||
navigation bar, click End Control below the device to end control of the
|
||||
device.
|
||||
If you control multiple devices, you can drag and drop windows to change
|
||||
the display ratio of each screen.
|
||||
Hover the mouse over
|
||||
|
||||
|
||||
|
||||
|
||||
16 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
to view the device’s current bandwidth, delay, packet loss and other
|
||||
network information.
|
||||
|
||||
|
||||
|
||||
|
||||
Remote Access
|
||||
Through remote access, you can enter the Web backend of the device's internal
|
||||
network IP, view and modify all function menu pages, and achieve real-time
|
||||
monitoring of connected sub-devices, configuration effects, and other data for
|
||||
the central control device.
|
||||
|
||||
Prerequisites
|
||||
Supported device model for remote access: CT200.
|
||||
The device must already be bound to a meeting room with an Room pro license.
|
||||
Ensure that the network environment requirements for remote access are met based on the
|
||||
enterprise site, and open the relevant domains and ports.
|
||||
The device must be online.
|
||||
Remote access must be enabled on the device System Settings > System > Cloud
|
||||
Service.
|
||||
|
||||
|
||||
|
||||
|
||||
17 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Procedure
|
||||
1. On the Diagnose page, click Remote Access.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Wait for the terminal to respond, and you can start remote access.
|
||||
3. Refer to the CT200 User Guide to operate.
|
||||
|
||||
|
||||
|
||||
|
||||
18 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
Click End Remote access in the upper-right corner of the interface to stop control.
|
||||
|
||||
|
||||
|
||||
|
||||
Health Check
|
||||
Introduction
|
||||
Health Check operation supports the one-click quick diagnosis of the device.
|
||||
Based on the diagnosis results, you can perform related operations (such as
|
||||
upgrading, restarting, or restoring factory settings, etc.) with one click to quickly
|
||||
solve problems for the device.
|
||||
The examination includes the following inspection items:
|
||||
|
||||
Physical Instruction Exception Supported device models
|
||||
examinat s handling
|
||||
ion suggestions
|
||||
content
|
||||
|
||||
Host Check if If an updated Android conference room
|
||||
Version there is an version is equipment, smart screen,
|
||||
official detected, it is MVC series equipment
|
||||
firmware recommended to
|
||||
|
||||
|
||||
19 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
version that upgrade the device
|
||||
can be to the latest
|
||||
updated. version
|
||||
|
||||
Periphera Check the If there are offline Android conference room
|
||||
ls information accessories, it is equipment, smart screen,
|
||||
Version/ of each recommended to MVC series equipment
|
||||
Status accessory check whether the
|
||||
connected accessory
|
||||
to the host connection is
|
||||
device, normal; if an
|
||||
including: updated version is
|
||||
model, detected, it is
|
||||
firmware recommended to
|
||||
version, upgrade the
|
||||
and online accessory version.
|
||||
status.
|
||||
|
||||
Remainin Check If the memory Android conference room
|
||||
g whether usage of the host equipment, smart screen
|
||||
Storage the device reaches the
|
||||
Space remaining threshold set by
|
||||
storage the enterprise,
|
||||
space of the please check and
|
||||
host device stop unnecessary
|
||||
is too low. running tasks.
|
||||
|
||||
Memory Check If the memory Android conference room
|
||||
Usage whether usage of the host equipment, smart screen
|
||||
Rate the host device reaches the
|
||||
device threshold set by
|
||||
memory the enterprise,
|
||||
|
||||
20 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
usage is too please check and
|
||||
high. stop unnecessary
|
||||
running tasks.
|
||||
|
||||
CPU Check If the CPU usage of Android conference room
|
||||
whether the host device equipment, smart screen
|
||||
the host reaches the
|
||||
device CPU threshold set by
|
||||
usage is too the enterprise,
|
||||
high. please check and
|
||||
stop unnecessary
|
||||
running tasks.
|
||||
|
||||
Prerequisites
|
||||
Only Android conference room devices, MeetingBoard, and MVC series devices support this
|
||||
function.
|
||||
For Android devices, if the version is lower than V31, the (CPU/Memory/Storage) inspection
|
||||
items can not be detected.
|
||||
|
||||
Procedure
|
||||
1. On the device diagnosis page, click Health Check.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click Start to check the current health status of the device. Meanwhile, you can click
|
||||
Terminate to stop the examination.
|
||||
21 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. After the test is completed, the interface will display various test results. For abnormal
|
||||
items, please perform corresponding operations according to the prompts and suggestions
|
||||
on the interface.
|
||||
|
||||
|
||||
|
||||
|
||||
Supported Diagnosing Methods
|
||||
Diagnostic methods
|
||||
|
||||
Device One- Capt Expor Export the Capture Netw Con Rem
|
||||
Models click ure t Configurat the ork fig ote
|
||||
Expo Pack Syste ion Files Screen Detec bac Con
|
||||
|
||||
|
||||
22 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
rt ets m shot tion kup trol
|
||||
Logs
|
||||
|
||||
Meeting √ √ √ √ √ √ √
|
||||
Board
|
||||
|
||||
VCS √ √ √ √ √ √ √ √
|
||||
device
|
||||
s（Meet
|
||||
ingBar
|
||||
）
|
||||
|
||||
MVC √ √
|
||||
devices
|
||||
|
||||
RoomCa √ √ √ √ √
|
||||
st
|
||||
|
||||
RoomPa √ √ √ √ √
|
||||
nel/
|
||||
RoomPa
|
||||
nel Plus
|
||||
|
||||
|
||||
|
||||
Frequently Used Rules for Packet Capturing
|
||||
The following are commonly used packet capture strings, which you can apply
|
||||
to device diagnosis according to the actual situation.
|
||||
|
||||
String Example Description
|
||||
|
||||
host IP host Only see the incoming and outgoing traffic of a
|
||||
10.81.36.16 specific IP.
|
||||
|
||||
Port port 90 Only see the incoming and outgoing traffic of a
|
||||
numbe specific port.
|
||||
r
|
||||
|
||||
23 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Portran portrange Only see the traffic belonging to a specific port
|
||||
ge 21-23 range.
|
||||
value1-
|
||||
value2
|
||||
|
||||
tcp tcp port 23 Check who controls the phone via telnet.
|
||||
port 23 and host
|
||||
and 10.81.36.16
|
||||
host IP .
|
||||
|
||||
port 80 / Check the packets of the requests received and the
|
||||
responses sent by your phone web user interface.
|
||||
|
||||
net IP/ net Only capture the packet from the resource IP
|
||||
mask 10.91.33.0/ address or the destination IP address.
|
||||
24
|
||||
|
||||
src src host Only capture the packet send by the IP 10.81.36.16.
|
||||
10.81.36.16
|
||||
|
||||
src port 80 Only capture the packet send by port 80.
|
||||
|
||||
src Only capture the packet send by the port number
|
||||
portrange from 21 to 23.
|
||||
21-23
|
||||
|
||||
dst dst host Only capture the packet received by the IP
|
||||
10.81.36.16 10.81.36.16.
|
||||
|
||||
dst port 80 Only capture the packet received by the port
|
||||
number 80.
|
||||
|
||||
dst Only capture the packet received by the port
|
||||
portrange number from 21 to 23.
|
||||
21-23
|
||||
|
||||
and host Both of the objects before or after and. This example
|
||||
|
||||
|
||||
24 / 197
|
||||
@@ -0,0 +1,449 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 381-400
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 381-400 of 953
|
||||
**Chunk:** 20
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
10.81.33.32 means capturing the packet of IP 10.81.36.16 and IP
|
||||
and 10.81.36.18 or 10.81.33.56.
|
||||
(10.81.33.12
|
||||
or
|
||||
10.81.33.56
|
||||
)
|
||||
|
||||
or (10.81.33.12 Either the objects before or after or. This example
|
||||
or means IP 10.81.36.18 or 10.81. 33.56.
|
||||
10.81.33.56
|
||||
)
|
||||
|
||||
and !, ip host Neither of them. This example means that not
|
||||
and not 10.81.36.16 capturing the packet of IP 10.81.36.16 and IP
|
||||
and ! 10.81.36.18.
|
||||
10.81.36.18,
|
||||
ip host
|
||||
10.81.36.16
|
||||
and
|
||||
not10.81.36
|
||||
.18
|
||||
|
||||
|
||||
|
||||
System Log Level
|
||||
Log Log name Description
|
||||
level
|
||||
|
||||
0 system is Emergency information. The system may no longer
|
||||
unusable be available.
|
||||
|
||||
1 action Alert message. The service is down and may affect
|
||||
must be the normal use of the system, requiring immediate
|
||||
|
||||
|
||||
25 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
taken action.
|
||||
immediatel
|
||||
y
|
||||
|
||||
2 critical More serious error messages. The service is down
|
||||
conditions and may not be repaired.
|
||||
|
||||
3 error Error message. There is a problem with the service
|
||||
conditions and it cannot be confirmed whether it is working
|
||||
properly.
|
||||
|
||||
4 warning Warning message. There may have been a problem
|
||||
conditions with the program, but it does not affect normal
|
||||
operation.
|
||||
|
||||
5 normal but Normal but important reminders. The program
|
||||
significant needs to be checked, otherwise there may be
|
||||
condition problems.
|
||||
|
||||
6 informatio General notification messages. Used to provide
|
||||
nal feedback to the user on the current system status.
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Device（Task
|
||||
Management）
|
||||
Task Executing Rules
|
||||
Task name Execution rules Room devices
|
||||
|
||||
Reboot Reboot the selected device. √
|
||||
|
||||
Restore to Reset the selected devices to the √
|
||||
factory factory.
|
||||
|
||||
Send message Send messages to selected devices. √
|
||||
|
||||
Config backup Backup all historical configuration files √
|
||||
to prevent situations where device
|
||||
damage or other incidents result in the
|
||||
inability to restore configuration files.
|
||||
|
||||
Config restore Restore the current configuration to √
|
||||
the historical version.
|
||||
|
||||
Push resource Push resource files to the selected √
|
||||
file devices. You can only push one file of
|
||||
the same resource type at a time to the
|
||||
selected devices. Only the resource file
|
||||
supported by the device can be
|
||||
pushed.
|
||||
|
||||
Update Update the selected devices’ √
|
||||
firmware firmware. If you select the devices of
|
||||
different models, only the firmware
|
||||
applicable to all the devices can be
|
||||
updated.
|
||||
|
||||
27 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
Scheduled Tasks
|
||||
Scheduled Task Modes
|
||||
|
||||
Task Description
|
||||
modes
|
||||
|
||||
Instant The task will be executed immediately.
|
||||
task
|
||||
|
||||
One-time The task will be executed once at the scheduled time you set.
|
||||
task
|
||||
|
||||
Recurring The task will be executed periodically at the scheduled time
|
||||
task you set (daily/weekly/monthly).
|
||||
|
||||
|
||||
|
||||
Add Scheduled Tasks
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Tasks > Scheduled Task.
|
||||
3. Click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
4. Select a range and click Next.
|
||||
Devices: Select All, Site, Group,or Custom.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit the task information.
|
||||
Task Name: Enter the task name.
|
||||
Execution Mode: Select the execution mode as Immediately, One-time Task, Daily,
|
||||
Every Week, or Every Month.
|
||||
Task: Select the task type.
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Complete. The task will be executed according to your settings.
|
||||
|
||||
💡 NOTE
|
||||
If you add multiple tasks for one device, those tasks are lined up to run in order of
|
||||
their configured execution time.
|
||||
If the device is offline, the task will not be executed.
|
||||
If the task has not expired, it will be executed after the device is restored to an
|
||||
online state.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Scheduled Tasks
|
||||
Procedure
|
||||
Access the Scheduled Task List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Tasks > Scheduled Task.
|
||||
|
||||
View the Scheduled Task List
|
||||
You can view the task type, the execution status, the execution mode, and other
|
||||
information.
|
||||
Click View under the Devices tab to see which devices are executing this task and their
|
||||
|
||||
30 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
device types.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Execution Record
|
||||
1. In the scheduled task list, click Execution Record on the right side of the desired task.
|
||||
2. The record includes the execution time and the execution status.
|
||||
3. (Optional) Click Execution Details to view the execution result and the error reason of each
|
||||
executing device.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
31 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired pending or paused task and select Edit.
|
||||
|
||||
Pause Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
32 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the recurring task and select Pause.
|
||||
|
||||
Resume Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
33 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired paused task and select Continue. If the task has not
|
||||
expired, the task will be executed and completed on the time you set.
|
||||
|
||||
End Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
34 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> End.
|
||||
|
||||
💡 NOTE
|
||||
If you terminate an executing scheduled task, the task will continue to be
|
||||
executed until it completes. However, if you terminate a one-time or
|
||||
recurring task, it will no longer be executed.
|
||||
|
||||
Delete Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
35 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete to delete the finished tasks.
|
||||
|
||||
|
||||
|
||||
Executed Tasks
|
||||
View the Details of Executed Tasks
|
||||
Introduction
|
||||
With Execution Details, you can know about the execution result and the error
|
||||
reason of each device after they complete the task. In the following, we will
|
||||
introduce how to access the execution details.
|
||||
|
||||
Procedure
|
||||
|
||||
36 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Tasks.
|
||||
3. Do one of the following:
|
||||
On the Scheduled Task page, click Record > Details on the right side of the desired task.
|
||||
|
||||
|
||||
|
||||
|
||||
On the Execution Record page, click Details on the right side of the desired record.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Check the execution result and the error reason of each executing device.
|
||||
5. In the list, click Retry beside the desired device and confirm the action in the pop-up
|
||||
window. You can make this device to redo the task.
|
||||
|
||||
|
||||
|
||||
37 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Execution Records
|
||||
Introduction
|
||||
The execution records contain detailed information about the specific time,
|
||||
content, and execution status of all tasks within the enterprise, including each
|
||||
execution of periodic tasks.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Tasks > Execution Record.
|
||||
3. Check the execution time, content, and execution status of the scheduled task.
|
||||
4. (Optional) Click Details to view the execution result and the error reason of each executing
|
||||
device.
|
||||
|
||||
|
||||
|
||||
|
||||
38 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Devices（Data Statistics）
|
||||
Device Statistics
|
||||
Introduction
|
||||
You can view relevant device data under a site, including total device count,
|
||||
device status at different time points, device model statistics, firmware
|
||||
distribution statistics, device upgrade status, and other data.
|
||||
|
||||
Go to the Devices Statistics Page
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Statistics > Device Statistics.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired site. The statistics are given based on the site you select.
|
||||
|
||||
|
||||
|
||||
|
||||
39 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Total Count of Devices
|
||||
On the device statistics page, you can view the total number of devices and
|
||||
peripherals in the selected site.
|
||||
Clicking the total number of devices or peripherals will take you to the corresponding
|
||||
device management list.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Status
|
||||
On the device statistics page, you can view the status statistics based on the
|
||||
selected site and device type within the specified time range.
|
||||
40 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to see the status in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select a period and see the status during this period.
|
||||
Hover over to see the number of devices corresponding to each device status at that time
|
||||
point.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Model Statistics
|
||||
On the device statistics page, you can view the model statistics and different
|
||||
model proportions based on the selected site and device type.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to select devices models.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to export statistics according to the filter you set.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
42 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
43 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to expand/collapse the device model page.
|
||||
Click the horizontal axis beside the corresponding device model to go to the device
|
||||
management page of that device model.
|
||||
|
||||
|
||||
|
||||
|
||||
44 / 197
|
||||
@@ -0,0 +1,365 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 401-420
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 401-420 of 953
|
||||
**Chunk:** 21
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Firmware Statistics
|
||||
On the device statistics page, you can view the firmware distribution statistics
|
||||
and proportions based on the selected site and device type.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select devices models.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
45 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to export statistics according to the filter you set.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
46 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
47 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to expand/collapse the firmware distribution page.
|
||||
Click the horizontal axis beside the corresponding device model to go to the device
|
||||
management page of that device model.
|
||||
|
||||
|
||||
|
||||
|
||||
48 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Upgrade Status
|
||||
On the device statistics page, you can view the device upgrade status based on
|
||||
the selected site and device type.
|
||||
Click to switch and view the upgrade status of the host and accessories.
|
||||
Clicking the number under the Upgradable Devices column will take you to the device
|
||||
management page of that device model.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
49 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to upgrade all non-upgraded devices of the current model to the latest firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
50 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm Statistics
|
||||
Introduction
|
||||
Through visual alarm statistics, you can view alarm data for devices in each site,
|
||||
including total alarms, alarm trends, alarm records, and more.
|
||||
|
||||
Go to the Alarm Statistics Page
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Statistics > Alarm Statistics.
|
||||
|
||||
|
||||
|
||||
|
||||
51 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired site from the drop-down menu. The alarm statistics are given based on
|
||||
the site you select.
|
||||
|
||||
|
||||
|
||||
|
||||
Total Number of Alarms
|
||||
On the alarm statistics page, you can view the total number of alarms and active
|
||||
alarms based on the selected site.
|
||||
Clicking the total number of alarms or active alarm number will redirect you to the
|
||||
corresponding alarm list.
|
||||
|
||||
|
||||
|
||||
|
||||
52 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm Trend
|
||||
On the alarm statistics page, you can view the alarm status and its trend (not
|
||||
including today) based on the selected site and device type within the specified
|
||||
time range.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to see the status in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select a period and see the trend during this period.
|
||||
Hover over to see the number of alarms for each state at that time point.
|
||||
|
||||
|
||||
|
||||
|
||||
53 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm List
|
||||
On the alarm statistics page, you can view the details and proportions of
|
||||
different alarm events based on the selected site and device type.
|
||||
Click Details to view the details of this type of alarm event.
|
||||
|
||||
|
||||
|
||||
|
||||
54 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Devices（Resource
|
||||
Management）
|
||||
Firmware
|
||||
Add Firmware
|
||||
Introduction
|
||||
You can manage the firmware of your device in a unified way. Configure the
|
||||
relevant devices in the enterprise according to the actual situation.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the firmware-related information.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload.
|
||||
Firmware Name: The file name will be automatically filled in as the firmware name after
|
||||
uploading the file. You can also change it manually.
|
||||
Version: After uploading the file, the installation package information will be read, and
|
||||
|
||||
|
||||
55 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
the version number will be filled in automatically; you can also modify it manually.
|
||||
Supported Model: Select specific product model; multiple selections are available.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to this firmware for future traceability.
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
56 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Manage Firmware
|
||||
Procedure
|
||||
Go to the Firmware List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Firmware List
|
||||
1. Click the site name on the left side to view the data under this site.
|
||||
2. Check the firmware name, version number, and other information in the firmware list.
|
||||
|
||||
|
||||
|
||||
|
||||
57 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
For more information, see push the firmware.
|
||||
Copy Firmware Link
|
||||
For more information, see copy the firmware link.
|
||||
Download Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
58 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Download to download firmware locally.
|
||||
|
||||
Edit Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
59 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
|
||||
Delete Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
60 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
Push Firmware Immediately
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
61 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
4. In the pop-up window, select Immediately and click Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
62 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
Push Firmware on Scheduled Time
|
||||
Introduction
|
||||
With scheduled tasks, you can choose to push the firmware during the non-
|
||||
working time without affecting the working process.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
4. Select Scheduled Tasks in the pop-up window and edit the information about the
|
||||
|
||||
63 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
scheduled task. Click to Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
|
||||
|
||||
|
||||
Copy Firmware Link
|
||||
Introduction
|
||||
You can copy the firmware download link and share it with others. For security
|
||||
reasons, however, only devices within the enterprise can access this
|
||||
downloading link.
|
||||
Prerequisites
|
||||
Only devices within the enterprise can use this link to download the corresponding files.
|
||||
Direct access to this download link through your browser is not supported.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
64 / 197
|
||||
@@ -0,0 +1,389 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 421-440
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 421-440 of 953
|
||||
**Chunk:** 22
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired firmware and select Copy Link.
|
||||
|
||||
|
||||
|
||||
65 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Other Resources
|
||||
Add Resources
|
||||
Introduction
|
||||
You can add many types of files (e.g., wallpapers, ringtones, etc.) as resource
|
||||
files and assign them to the relevant devices in your enterprise, depending on
|
||||
the actual situation.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Others > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
66 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit resource-related information.
|
||||
Resource Type: Select the resource type. For more information, see the resource type
|
||||
description.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload. The file type
|
||||
should be the same as the resource type you selected in the previous option.
|
||||
Resource Name: The file name will be automatically filled in as the resource name after
|
||||
uploading the file; you can also change it manually.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to the resource for future traceability.
|
||||
4. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
67 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
68 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Manage Resources
|
||||
Procedure
|
||||
Go to the Resource List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Others.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Resource List
|
||||
1. Click the site name on the left side to view the data under this site.
|
||||
2. Check the resource name, the version number, and other information in the resource list.
|
||||
|
||||
|
||||
|
||||
|
||||
69 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Push Resource
|
||||
For more information, see push the resource.
|
||||
Copy Resource Link
|
||||
For more information, see copy the resource link.
|
||||
Download Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Download.
|
||||
|
||||
Edit Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
70 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Edit.
|
||||
|
||||
Delete Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
71 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Delete.
|
||||
|
||||
|
||||
|
||||
Push Resources
|
||||
Push Resources Immediately
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
|
||||
|
||||
|
||||
|
||||
72 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired resource.
|
||||
4. In the pop-up window, select Immediately and click Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
Push Resources on Scheduled Time
|
||||
Introduction
|
||||
With scheduled tasks, you can choose to push the resource during non-working
|
||||
time without affecting the working process.
|
||||
|
||||
73 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired resource.
|
||||
4. Select Scheduled Tasks in the pop-up window and edit the information about the
|
||||
scheduled task. Click to Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
|
||||
|
||||
74 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Copy Resource Link
|
||||
Introduction
|
||||
You can copy the resource download link and share it with others. For security
|
||||
reasons, however, only devices within the enterprise can access this
|
||||
downloading link.
|
||||
|
||||
Prerequisites
|
||||
Only devices within the enterprise can use this link to download the corresponding files.
|
||||
Direct access to this download link through your browser is not supported.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Phone Device > Resources > Others.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
75 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and select Copy Link.
|
||||
|
||||
|
||||
|
||||
|
||||
76 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction on Resource Type
|
||||
|
||||
|
||||
Resource type Description Supported file File size
|
||||
names types limit
|
||||
|
||||
SkypeSettings Skype configuration .xml/ .zip 50M
|
||||
|
||||
DST Template Daylight Saving Time .xml 2M
|
||||
template
|
||||
|
||||
Language Packet Language packages .lang 2M
|
||||
|
||||
Input Method Input methods .txt 2M
|
||||
|
||||
Lync Phone Device licenses .dat/ .zip 50M
|
||||
License
|
||||
|
||||
Local Directory XML contacts .xml 2M
|
||||
File(XML)
|
||||
|
||||
Local Directory CSV contacts .csv 2M
|
||||
File(CSV)
|
||||
|
||||
Wallpaper Wallpapers .png/ .jpg/ .bmp 5M
|
||||
|
||||
Screensaver Screensavers .png/ .jpg/ .bmp 5M
|
||||
|
||||
Logo Logos .png/ .jpg/ .bmp 2M
|
||||
|
||||
Web Item Level Three levels of .cfg 2M
|
||||
Template authority
|
||||
|
||||
Trusted Trusted certificates .pem/ .cer/ .crt/ 5M
|
||||
Certificates .der
|
||||
|
||||
Server Certificates Server certificates .pem/ .cer 5M
|
||||
|
||||
Proxy Auto-config Auto configure proxy .pac 2M
|
||||
|
||||
FAQ
|
||||
How to push the SkypeSettings file to the conference room
|
||||
77 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
equipment through YMCS?
|
||||
1. Please refer to the official Microsoft documentation to configure the XML file.
|
||||
|
||||
💡 TIP
|
||||
By configuring the XML file, you can customize relevant information such as Teams
|
||||
conference room account, password, and user name.
|
||||
|
||||
|
||||
2. Add a resource, selecting the resource type as SkypeSettings.
|
||||
3. Push the XML file to the desired devices.
|
||||
|
||||
|
||||
|
||||
YRC Software
|
||||
Add Resources
|
||||
Yealink Room Connect (YRC) is a device management software for Windows
|
||||
room device. You can upload a new version of YRC and push to the specified
|
||||
online device range.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > Room Device > YRC Management > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit resource-related information.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload. The file type
|
||||
should be the same as the resource type you selected in the previous option.
|
||||
Resource Name: The file name will be automatically filled in as the resource name after
|
||||
|
||||
78 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
uploading the file; you can also change it manually.
|
||||
Version: The version will be automatically filled in after uploading the file; you can also
|
||||
change it manually.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to the resource for future traceability.
|
||||
4. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
79 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Resources
|
||||
80 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
Go to the Resource List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device Management > Room Device > YRC Management.
|
||||
|
||||
|
||||
View the Resource List
|
||||
1. Click the area name on the left side to view the data under this area.
|
||||
2. Check the resource name, the version number, and other information in the resource list.
|
||||
|
||||
|
||||
|
||||
|
||||
Push Resource
|
||||
1. Click Push on the right side of the desired resource.
|
||||
2. In the pop-up window, select Immediatelyor Scheduled Task and click Select Device .
|
||||
|
||||
|
||||
|
||||
|
||||
81 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired device and click Save.
|
||||
4. Complete pushing.
|
||||
|
||||
Copy Resource Link
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Resources > YRC Management.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
82 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and select Copy Link .
|
||||
|
||||
|
||||
|
||||
|
||||
Download Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
83 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Download.
|
||||
|
||||
Edit Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
84 / 197
|
||||
@@ -0,0 +1,407 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 441-460
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 441-460 of 953
|
||||
**Chunk:** 23
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Edit.
|
||||
|
||||
Delete Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
85 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
86 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Personal Device（Devices）
|
||||
Deploy USB Devices
|
||||
YMCS currently does not support manually adding USB devices to the platform.
|
||||
If you wish to add USB devices to the platform and manage them, you can
|
||||
achieve this through bulk deployment. For more information, please refer to the
|
||||
USB Device Bulk Deployment guide.
|
||||
|
||||
|
||||
|
||||
Yealink USB Connect（YUC）
|
||||
View the YUC List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Yealink USB Connect.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
View YUC information such as status, MAC, etc.; you can click
|
||||
|
||||
|
||||
|
||||
|
||||
87 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select the fields to display.
|
||||
Click Advanced to customize the filtering criteria to find the YUC software; you can also
|
||||
click Save Search Label to save the filtering criteria as a tag for subsequent use.
|
||||
In the Label field, click a label to view information about all YUC software under that
|
||||
label.
|
||||
In the Label field, click More > Label Management to sort, edit, and delete labels.
|
||||
|
||||
|
||||
|
||||
Operations on the YUC List
|
||||
Go to the YUC List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Yealink USB Connect to go to the list.
|
||||
|
||||
|
||||
|
||||
|
||||
88 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Check Connected Device
|
||||
Click View under the Connected Device tap to jump to the device list to view
|
||||
the devices connected to the YUC.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The version of YUC needs to be 4.38.0.0 and higher to support this
|
||||
function.
|
||||
|
||||
|
||||
|
||||
89 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Export YUC
|
||||
Introduction
|
||||
You can export the basic information of all YUC in the list with one click.
|
||||
Procedure
|
||||
1. (Optional) In the YUC list, you can filter the exported devices by searching or filtering fields
|
||||
such as the MAC or the belonging site.
|
||||
2. Click Export.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
90 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
View YUC Details
|
||||
Procedure
|
||||
1. In the YUC list, click any YUC name. For more information, see YUC details.
|
||||
|
||||
Diagnose YUC
|
||||
Procedure
|
||||
1. In the YUC list, Click Diagnosis on the right side of the desired YUC. For more information,
|
||||
|
||||
91 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
see diagnose devices.
|
||||
|
||||
Delete YUC
|
||||
Procedure
|
||||
1. In the YUC list, do one of the following:
|
||||
|
||||
💡 NOTE
|
||||
After deletion, the YUC and connected devices will be disconnected from the platform, and
|
||||
the data can be recovered after re-reporting.
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the desired YUC.
|
||||
Select the desired YUCs and click > Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
92 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Update Software
|
||||
Procedure
|
||||
1. In the YUC list, select the YUC you want to update and click Update Software.
|
||||
|
||||
💡 TIP
|
||||
If you want to update the software of all the YUC on the site one time, you can click the
|
||||
Update on the top right corner.
|
||||
|
||||
|
||||
|
||||
|
||||
93 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Select the software version in the pop-up window.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Software Configuration
|
||||
1. In the YUC list, Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Software configuration on the right side of the desired YUC.
|
||||
2. For more information, see Software Configuration.
|
||||
|
||||
💡 NOTE
|
||||
The version of YUC needs to be 4.38.0.0 and higher to support this
|
||||
function.
|
||||
|
||||
|
||||
|
||||
94 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Set Sites
|
||||
Procedure
|
||||
1. In the YUC list, do one of the following:
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Site Settings on the right side of the desired YUC.
|
||||
Select the desired YUC and click Site Settings.
|
||||
|
||||
|
||||
|
||||
|
||||
95 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Select the site to which you want the YUC to belong in the pop-up window and click
|
||||
Confirm.
|
||||
|
||||
💡 NOTE
|
||||
After confirmation, the software and the devices associated will be
|
||||
moved together to the new site.
|
||||
|
||||
|
||||
|
||||
View YUC Details
|
||||
Prerequisites
|
||||
The version of YUC needs to be 4.38.0.0 and higher to support this function.
|
||||
|
||||
Go to the Details Page of YUC
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Yealink USB Connect.
|
||||
|
||||
|
||||
|
||||
|
||||
96 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the device list, click the desired YUC name to view the details.
|
||||
|
||||
View Basic YUC Information
|
||||
Procedure
|
||||
1. On the details page, view the computer name, the software version, the model, and other
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
Diagnose YUC
|
||||
Procedure
|
||||
1. On the details page, click Yealink USB Connect diagnostics.
|
||||
97 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Perform basic operations such as updating software.
|
||||
Diagnose the YUC by exporting system logs.
|
||||
|
||||
💡 NOTE
|
||||
If exporting logs fails, please check the YUC version and make sure it is 4.38.0.0 or higher.
|
||||
|
||||
|
||||
Yealink USB Connect Configuration
|
||||
For more detailed information about software configuration, please refer to:
|
||||
Software Configuration.
|
||||
|
||||
|
||||
|
||||
USB Device
|
||||
View the USB Device List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Device.
|
||||
|
||||
|
||||
|
||||
|
||||
98 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
View device information such as device models, IP number, etc.; you can click
|
||||
|
||||
|
||||
|
||||
|
||||
99 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
and select the fields to display.
|
||||
Click Advanced to customize the filtering criteria to find devices; you can also click Save
|
||||
Search Label to save the filtering criteria as a tag for subsequent use.
|
||||
In the Label field, click a label to view information about all devices under that label.
|
||||
In the Label field, click More > Label Management to sort, edit, and delete labels.
|
||||
|
||||
|
||||
|
||||
Operations on the USB Device List
|
||||
Go to the USB Device List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personnal Device > Device > Device to go to the USB device list.
|
||||
|
||||
|
||||
|
||||
|
||||
Check Connected Yealink USB Connect
|
||||
Click the Yealink USB Connect field corresponding to the device to jump to the
|
||||
YUC details page of the device connection.
|
||||
|
||||
|
||||
|
||||
|
||||
100 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The version of YUC needs to be 4.38.0.0 and higher to support this
|
||||
function.
|
||||
|
||||
|
||||
Export Devices
|
||||
Introduction
|
||||
You can export the basic information of all devices in the list with one click.
|
||||
Procedure
|
||||
1. (Optional) In the USB device list, you can filter the exported devices by searching or filtering
|
||||
fields such as the model number or the belonging site.
|
||||
2. Click Export.
|
||||
|
||||
|
||||
|
||||
|
||||
101 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
102 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
View Device Details
|
||||
Procedure
|
||||
1. In the USB device list, click any device name. For more information, see USB device details.
|
||||
|
||||
Diagnose Devices
|
||||
Procedure
|
||||
1. In the USB device list, click Diagnosis on the right side of the desired device. For more
|
||||
|
||||
|
||||
103 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
information, see diagnose devices.
|
||||
|
||||
Delete Devices
|
||||
Procedure
|
||||
1. In the USB hone device list, do one of the following:
|
||||
|
||||
💡 NOTE
|
||||
After deletion, the device will be disconnected from the platform, and the data can be
|
||||
recovered after re-reporting.
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the desired device.
|
||||
Select devices and click Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
104 / 197
|
||||
@@ -0,0 +1,743 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 461-480
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 461-480 of 953
|
||||
**Chunk:** 24
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Configuration
|
||||
Procedure
|
||||
1. In the USB device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Device Configuration on the right side of the desired device.
|
||||
2. In the configuration page, config the device according to your needs.
|
||||
|
||||
|
||||
|
||||
105 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
Click Device Configuration in Bulk to view batch deployment.
|
||||
|
||||
|
||||
Update Firmware
|
||||
Procedure
|
||||
1. In the USB device list, select devices and click Update Firmware(Button 1).
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you want to update the firmware of all the devices on the site one time,
|
||||
you can click the Update Firmware (Button 2) on the top right corner.
|
||||
106 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. In the pop-up window, select the firmware version. For more information, refer to firmware
|
||||
management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the device has an associated accessory, you can also select whether to update the firmware
|
||||
for the accessory in the pop-up window.
|
||||
|
||||
|
||||
Set Sites
|
||||
The USB device cannot set the site independently, and the site needs to be
|
||||
adjusted according to the connected YUC software. For more information, refer
|
||||
to YUC Site Setting.
|
||||
|
||||
|
||||
View USB Device Details
|
||||
Go to the Details Page of the USB Device
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Device > Device.
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the device list, click the desired device name to view the device details.
|
||||
|
||||
|
||||
|
||||
|
||||
107 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View Basic Device Information
|
||||
Procedure
|
||||
1. On the details page, view the device ID, the host IP, the model, and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
Diagnose Devices
|
||||
Procedure
|
||||
1. On the details page, click Diagnose.
|
||||
|
||||
|
||||
|
||||
|
||||
108 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Perform basic operations such as updating firmware and exporting logs.
|
||||
Diagnose the device by exporting system logs, etc. For more information, see diagnose
|
||||
devices.
|
||||
|
||||
Device Configuration
|
||||
For more detailed information about device configuration, please refer to Device
|
||||
Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
109 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Personal
|
||||
Device（Configuration）
|
||||
Device Configuration
|
||||
Introduction
|
||||
Select the model you want to configure, the configuration effect will be synchronized to all
|
||||
devices of the corresponding model under the site.
|
||||
|
||||
💡 NOTE
|
||||
For more information about configure a single device, see Single Configuration.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Configuration > Device Configuration.
|
||||
3. Click Configuration to batch configure a certain model of device under the currently
|
||||
selected site.
|
||||
|
||||
|
||||
|
||||
|
||||
Configuration
|
||||
Different headset types support different configuration items, as follows:
|
||||
|
||||
CP700&CP900
|
||||
|
||||
110 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Settings Configuration Defaul Permitted Description
|
||||
t Value
|
||||
|
||||
Device Bluetooth Bluetooth 0-off 0-off Turn Bluetooth
|
||||
Settings 1-on function on or off
|
||||
|
||||
Ring Type Local 0-off 0-off Turn local ringtone on
|
||||
Ringtone 1-on or off
|
||||
|
||||
BT50&BT51
|
||||
Settings Configuration Default Permitted Description
|
||||
Value
|
||||
|
||||
Device Wireless Range 1-Long 1-Long Set DECT wireless
|
||||
Settings 2-Medium distance/transmit
|
||||
3-Short power
|
||||
|
||||
MP50
|
||||
Settings Configuration Defau Permitt Description
|
||||
lt ed
|
||||
Value
|
||||
|
||||
Basic Genera Bluetoot 0-off 0-off Turn Bluetooth function on or off
|
||||
Settings l h 1-on
|
||||
|
||||
Device Yealin N/A User-defined device Bluetooth
|
||||
Name k name
|
||||
MP50
|
||||
|
||||
Discover 300-5 0- Set the length of time this unit can
|
||||
able min Forever be discovered by other Bluetooth
|
||||
Time 300-5mi devices
|
||||
n
|
||||
600-10m
|
||||
in
|
||||
1800-30
|
||||
min
|
||||
3600-60
|
||||
min
|
||||
|
||||
111 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Date 0- 0-MMM Set date display format
|
||||
Format MMM DD
|
||||
DD 1-DD
|
||||
MMM
|
||||
|
||||
Time 1-24 0-12 Set time display format
|
||||
Format Hour Hour
|
||||
1-24
|
||||
Hour
|
||||
|
||||
Sound Dial 1-on 0-off Set whether to sound the
|
||||
Tone 1-on connection pre-dial tone after
|
||||
entering the dial pad
|
||||
|
||||
Keypad 1-on 0-off Set whether to play key tone
|
||||
Tone 1-on
|
||||
|
||||
Speaker 8 Min Set the local default playback
|
||||
Volume Number volume (0-15)
|
||||
:0
|
||||
Max
|
||||
Number
|
||||
:15
|
||||
|
||||
PC Base 8 Min Set the base ringtone volume for
|
||||
Softph Ringtone Number incoming calls (0-15)
|
||||
one Volume :0
|
||||
Max
|
||||
Number
|
||||
:15
|
||||
|
||||
Local 0- 0- Select a local ringtone for
|
||||
Ring Ring1 Ring1.w incoming calls from a USB-
|
||||
Type .wav av- connected device
|
||||
Ring1.w
|
||||
av
|
||||
1-
|
||||
Ring2.w
|
||||
av-
|
||||
|
||||
|
||||
112 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Ring2.w
|
||||
av
|
||||
2-
|
||||
Ring3.w
|
||||
av-
|
||||
Ring3.w
|
||||
av
|
||||
3-
|
||||
Ring4.w
|
||||
av-
|
||||
Ring4.w
|
||||
av
|
||||
4-
|
||||
Ring5.w
|
||||
av-
|
||||
Ring5.w
|
||||
av
|
||||
|
||||
Mobile Base 8 Min Set the base ringtone volume
|
||||
Device Ringtone Number when Bluetooth device 1 receives
|
||||
1 Volume :0 a call
|
||||
Max
|
||||
Number
|
||||
:15
|
||||
|
||||
Local 0- 0- Select the local ringtone for
|
||||
Ring Ring1 Ring1.w incoming calls from Bluetooth
|
||||
Type .wav av- device 1
|
||||
Ring1.w
|
||||
av
|
||||
1-
|
||||
Ring2.w
|
||||
av-
|
||||
Ring2.w
|
||||
av
|
||||
2-
|
||||
|
||||
|
||||
113 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Ring3.w
|
||||
av-
|
||||
Ring3.w
|
||||
av
|
||||
3-
|
||||
Ring4.w
|
||||
av-
|
||||
Ring4.w
|
||||
av
|
||||
4-
|
||||
Ring5.w
|
||||
av-
|
||||
Ring5.w
|
||||
av
|
||||
|
||||
Mobile Base 8 Min Set the base ringtone volume
|
||||
Device Ringtone Number when Bluetooth device 2 receives
|
||||
2 Volume :0 a call
|
||||
Max
|
||||
Number
|
||||
:15
|
||||
|
||||
Local 0- 0- Select the local ringtone for
|
||||
Ring Ring1 Ring1.w incoming calls from Bluetooth
|
||||
Type .wav av- device 2
|
||||
Ring1.w
|
||||
av
|
||||
1-
|
||||
Ring2.w
|
||||
av-
|
||||
Ring2.w
|
||||
av
|
||||
2-
|
||||
Ring3.w
|
||||
av-
|
||||
Ring3.w
|
||||
|
||||
|
||||
114 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
av
|
||||
3-
|
||||
Ring4.w
|
||||
av-
|
||||
Ring4.w
|
||||
av
|
||||
4-
|
||||
Ring5.w
|
||||
av-
|
||||
Ring5.w
|
||||
av
|
||||
|
||||
Displa Teams 0- 0- Choose whether to continue
|
||||
y User Perso Personal selecting Teams account
|
||||
Name nal Mode information after removing the
|
||||
Mode 1-Hot device.
|
||||
Desking It will continue to be displayed in
|
||||
Mode personal mode, and will not be
|
||||
displayed in mobile office mode
|
||||
(only under Teams version UI)
|
||||
|
||||
Dark 0-off 0-off After turning it on, the
|
||||
Theme 1-on background color will change to a
|
||||
dark tone, suitable for night mode
|
||||
(only under Teams version UI)
|
||||
|
||||
Backlight 6 Min Set screen brightness
|
||||
Active Number
|
||||
Level :1
|
||||
Max
|
||||
Number
|
||||
:10
|
||||
|
||||
Backlight 0- 0- If no operation is performed after
|
||||
Time Alway Always this time, the screen will turn off.
|
||||
s on on
|
||||
1800-30
|
||||
|
||||
|
||||
115 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
min
|
||||
3600-1h
|
||||
7200-2h
|
||||
14400-4
|
||||
h
|
||||
21600-6
|
||||
h
|
||||
28800-8
|
||||
h
|
||||
43200-1
|
||||
2h
|
||||
|
||||
Screensa 7200- 30-30s Display saver wait time
|
||||
ver Wait 2h 60-1min
|
||||
Time 120-2mi
|
||||
n
|
||||
300-5mi
|
||||
n
|
||||
600-10m
|
||||
in
|
||||
900-15m
|
||||
in
|
||||
1200-20
|
||||
min
|
||||
1800-30
|
||||
min
|
||||
2700-45
|
||||
min
|
||||
3600-1h
|
||||
7200-2h
|
||||
|
||||
Screensa 0- 0- Choose to display built-in
|
||||
ver Syst System screensaver images or custom
|
||||
Backgro em 1- screensaver images
|
||||
und Custom
|
||||
|
||||
Custom
|
||||
|
||||
116 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Images
|
||||
|
||||
Genera USB 0- 0- Control how the speaker on the
|
||||
l Compute Insta Instant base plays non-call audio from
|
||||
r Audio nt 1- the USB device when the headset
|
||||
Delayed is placed on the base.
|
||||
2-Never
|
||||
3-
|
||||
Always
|
||||
|
||||
Calling Auto Dial 0-off 0-off Set whether to turn on the
|
||||
1-on automatic outgoing call
|
||||
function,_x000D_ After opening:
|
||||
the dial pad will automatically dial
|
||||
out 5 seconds after entering the
|
||||
number.
|
||||
|
||||
Call 0- 0- Select default calling device
|
||||
Device Autom Automat
|
||||
atic ic
|
||||
1-PC
|
||||
Softpho
|
||||
ne
|
||||
2-
|
||||
Mobile
|
||||
device1
|
||||
3-
|
||||
Mobile
|
||||
device2
|
||||
|
||||
Call 2- 1- After setting the priority of
|
||||
Priority New Current multiple calls after answering a
|
||||
call call new call during a call, the terminal
|
||||
2-New device needs to be picked up to
|
||||
call take effect.
|
||||
|
||||
Call 0-off 0-off After turning it on, the computer-
|
||||
Recordin 1-on side recording software
|
||||
|
||||
|
||||
117 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
g connected through USB (PC)
|
||||
records the call sound of
|
||||
terminals other than this
|
||||
connection.
|
||||
|
||||
Comfort 1-on 0-off The local call is Mute, and a weak
|
||||
Noise 1-on comfortable noise is added to
|
||||
remind the other party that the
|
||||
call is online.
|
||||
|
||||
Noise 1-on 0-off Set whether to turn on the
|
||||
Suppres 1-on environmental noise cancellation
|
||||
sion function
|
||||
|
||||
Smart 0-off 0-off Set whether to enable intelligent
|
||||
Noise 1-on ambient noise cancellation
|
||||
Block
|
||||
|
||||
Acoustic 0-off 0-off Set whether to enable soundproof
|
||||
Shield 1-on hood mode
|
||||
Mode
|
||||
|
||||
Acoustic 2 1,2,3 Set sound blocking level
|
||||
Shield
|
||||
Level
|
||||
|
||||
Hearin Anti- 0- 0-Peak Set hearing protection mode
|
||||
g Startle Peak Block
|
||||
Protec Protecti Block Protect
|
||||
tion on Prote ion
|
||||
ction 1-
|
||||
Australi
|
||||
an G616
|
||||
Protect
|
||||
ion
|
||||
|
||||
Daily 0-No 0-No Set the sound pressure level to be
|
||||
Noise Limit Limiting retained on noise days
|
||||
Exposur ing 1-80dB
|
||||
e A
|
||||
|
||||
118 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2-85dB
|
||||
A
|
||||
|
||||
Daily 8-8 2-2 Set daily headphone usage
|
||||
Noise hours hours amount
|
||||
Exposure 4-4
|
||||
Time hours
|
||||
6-6
|
||||
hours
|
||||
8-8
|
||||
hours
|
||||
|
||||
UH34&UH36
|
||||
Settings Configuration Default Permitted Value Description
|
||||
|
||||
Basic Local RingTone Disabled Enabled Set whether to
|
||||
Settings Disabled enable local
|
||||
ringtones
|
||||
|
||||
Advanced Anti-Startle Peak Block Peak Block Set hearing
|
||||
Settings Protection Protection Protection protection
|
||||
Australian G616 support level
|
||||
Protection
|
||||
|
||||
Daily Noise No Limiting No Limiting Set the sound
|
||||
Exposure 80dBA pressure level to
|
||||
85dBA be retained on
|
||||
noise days
|
||||
|
||||
UH37
|
||||
Settings Configuratio Default Permitted Value Description
|
||||
n
|
||||
|
||||
Basic Local Disabled Enabled Set whether to
|
||||
Settings RingTone Disabled enable local
|
||||
ringtones
|
||||
|
||||
Speaker 8 0-15 Set local default
|
||||
Volume playback volume
|
||||
|
||||
119 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Auto Answer Enabled Enabled Incoming call
|
||||
Disabled scene setting: Pull
|
||||
down the
|
||||
microphone stalk
|
||||
to automatically
|
||||
answer the call
|
||||
|
||||
Advanced Smart Mute Enabled Enabled Set a regular
|
||||
Settings Reminder Disabled reminder to mute
|
||||
the microphone
|
||||
|
||||
Mute 20s 10s Set the interval for
|
||||
Detection 20s periodic
|
||||
Interval 30s reminders of
|
||||
1min microphone mute
|
||||
2min
|
||||
5min
|
||||
10min
|
||||
30min
|
||||
|
||||
Anti-Startle Peak Block Peak Block Set hearing
|
||||
Protection Protection Protection protection
|
||||
Australian G616 support level
|
||||
Protection
|
||||
|
||||
Daily Noise No Limiting No Limiting Set the sound
|
||||
Exposure 80dBA pressure level to
|
||||
85dBA be retained on
|
||||
noise days
|
||||
|
||||
Daily Noise 8 hours 2 hours Set daily
|
||||
Exposure 4 hours headphone usage
|
||||
Time 6 hours amount
|
||||
8 hours
|
||||
|
||||
MFB Button Play /Pause Play /Pause HOOK Supports setting
|
||||
the MFB button
|
||||
function in the
|
||||
non-incoming call
|
||||
|
||||
|
||||
120 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
state through YUC.
|
||||
|
||||
PC Call Device NA According to the Set the call control
|
||||
dynamic focus of the USB-
|
||||
enumeration of connected
|
||||
the software end computer running
|
||||
recognized by the software
|
||||
SDK/API, the
|
||||
display
|
||||
|
||||
Equalizer for 0-Normal 0-Normal Set audio
|
||||
Calls 1-Bass playback style
|
||||
2-Treble
|
||||
|
||||
Environment Adaptive Adaptive The device has
|
||||
Adaptation Noise three sets of built-
|
||||
Environment in uplink noise
|
||||
Quiet cancellation
|
||||
Environment algorithm
|
||||
OFF parameters. One
|
||||
set satisfies the
|
||||
subjective
|
||||
experience
|
||||
(configuration
|
||||
item [Adaptive
|
||||
and Noise
|
||||
Environment]
|
||||
shares this set of
|
||||
parameters), one
|
||||
set meets
|
||||
objective
|
||||
certification
|
||||
(configuration
|
||||
item [Quiet
|
||||
Environment]),
|
||||
and one set turns
|
||||
off cancellation.
|
||||
|
||||
121 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Noise algorithm is
|
||||
used for audio
|
||||
debugging. You
|
||||
can use this
|
||||
configuration to
|
||||
adjust the headset
|
||||
performance in
|
||||
different usage
|
||||
environments.
|
||||
|
||||
Platform 1-Teams 1-Teams Switch between
|
||||
2-UC Teams and UC
|
||||
modes. During a
|
||||
call in Teams
|
||||
mode, press and
|
||||
hold the logic to
|
||||
realize Teams
|
||||
raising hand. The
|
||||
UC version realizes
|
||||
hold and multi-
|
||||
channel call
|
||||
switching.
|
||||
|
||||
UH38
|
||||
Settings Configuration Default Permitted Description
|
||||
Value
|
||||
|
||||
Basic Settings Bluetooth 0-off 0-off Turn Bluetooth function
|
||||
1-on on or off
|
||||
|
||||
Device Name Yealink N/A User-defined device
|
||||
UH38 Bluetooth name
|
||||
|
||||
Local RingTone Disabled Enabled Set whether to enable
|
||||
Disabled local ringtones
|
||||
|
||||
Speaker 8 0-15 Set local default
|
||||
Volume playback volume
|
||||
|
||||
|
||||
122 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Advanced Smart Mute Enabled Enabled Set a regular reminder to
|
||||
Settings Reminder Disabled mute the microphone
|
||||
|
||||
Mute Detection 20s 10s Set the interval for
|
||||
Interval 20s periodic reminders of
|
||||
30s microphone mute
|
||||
1min
|
||||
2min
|
||||
5min
|
||||
10min
|
||||
30min
|
||||
|
||||
Anti-Startle Peak Peak Block Set hearing protection
|
||||
Protection Block Protection support level
|
||||
Protectio Australian
|
||||
n G616
|
||||
Protection
|
||||
|
||||
Daily Noise No No Limiting Set the sound pressure
|
||||
Exposure Limiting 80dBA level to be retained on
|
||||
85dBA noise days
|
||||
|
||||
Daily Noise 8 hours 2 hours Set daily headphone
|
||||
Exposure Time 4 hours usage amount
|
||||
6 hours
|
||||
8 hours
|
||||
|
||||
PC Call Device NA According to Set the call control focus
|
||||
the dynamic of the USB-connected
|
||||
enumeration computer running
|
||||
of the software
|
||||
software end
|
||||
recognized
|
||||
by the SDK/
|
||||
API, the
|
||||
display
|
||||
|
||||
Equalizer for 0-Normal 0-Normal Set audio playback style
|
||||
Calls 1-Bass
|
||||
|
||||
|
||||
123 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2-Treble
|
||||
|
||||
Second Device 0-Play 0-Play first Hear the audio (tone &
|
||||
Audio first priority music) from the other
|
||||
priority 1-Last connected device while
|
||||
playback streaming audio
|
||||
priority
|
||||
|
||||
BH71
|
||||
Settings Configuration Default Permitted Description
|
||||
Value
|
||||
|
||||
Gener Device Yealink N/A User-defined device
|
||||
al Name BH71 Bluetooth name
|
||||
|
||||
Soun Status Tone 0-Voice 0-Voice Configure prompt
|
||||
d Type 1-Tone tone type
|
||||
2-Off
|
||||
|
||||
Voice 0- 0-English Configure prompt
|
||||
Guidance English 1-Chinese voice language
|
||||
Language 2-German
|
||||
3-French
|
||||
4-Spanish
|
||||
5-Italian
|
||||
6-
|
||||
Portuguese
|
||||
7-Japanese
|
||||
8-Korean
|
||||
9-Dutch
|
||||
|
||||
Keypad 1-on 0-off Set whether to play
|
||||
Tone 1-on key tone
|
||||
|
||||
Second 0-off 0-off Hear notification
|
||||
Device 1-on tones from other
|
||||
Notifcation connected devices
|
||||
Tone while streaming
|
||||
audio
|
||||
|
||||
|
||||
124 / 197
|
||||
@@ -0,0 +1,869 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 481-500
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 481-500 of 953
|
||||
**Chunk:** 25
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Sleep Auto Sleep 8h 0-Never Set the time for the
|
||||
Mode 15-15min headset to enter
|
||||
30-30mi sleep mode when
|
||||
60-1h there is no device
|
||||
120-2h connection
|
||||
240-4h
|
||||
360-6h
|
||||
480-8h
|
||||
|
||||
Gener Mute 1-on 0-off 1-on After turning it on, if
|
||||
al Reminder the headset is muted
|
||||
during a call, the
|
||||
mute prompt can be
|
||||
heard on the headset
|
||||
|
||||
Mute 20-20s 10-10s After turning on Mute
|
||||
Reminder 20-20s regular reminder, the
|
||||
Interval 30-30s interval period of the
|
||||
60-1min regular reminder
|
||||
120-2min
|
||||
300-5min
|
||||
600-10mn
|
||||
1800-30min
|
||||
|
||||
Environmen 0- 0-Adaptive You can use this
|
||||
t Adaptive 1-Noise configuration to
|
||||
Adaptation Environmen adjust the headset
|
||||
t performance in
|
||||
2-Quiet different usage
|
||||
Environmen environments
|
||||
t
|
||||
3.-Off
|
||||
|
||||
Platform None Teams- Select the platform
|
||||
Teams based on the
|
||||
Platform environment
|
||||
UC-UC variables burned by
|
||||
platform the tool
|
||||
|
||||
125 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Callin PC Call None Dynamic Set PC software call
|
||||
g Device enumeration control focus
|
||||
and display
|
||||
of software
|
||||
terminals
|
||||
recognized
|
||||
by SDK/API
|
||||
|
||||
Equalizer 0- 0-Normal Call audio equalizer
|
||||
for Calls Normal 1-Bass settings
|
||||
2-Treble
|
||||
|
||||
Heari Anti-Startle 0-Peak 0-Peak Set hearing
|
||||
ng Protection Block Block protection mode
|
||||
Prote Protecti Protection
|
||||
ction on 1-Australian
|
||||
G616
|
||||
Protection
|
||||
|
||||
Daily Noise 0-No 0-No Set the sound
|
||||
Exposure Limiting Limiting pressure level to be
|
||||
1-80dBA retained on noise
|
||||
2-85dBA days
|
||||
|
||||
Daily Noise 8-8 2-2 hours Set daily headphone
|
||||
Exposure hours 4-4 hours usage amount
|
||||
Time 6-6 hours
|
||||
8-8 hours
|
||||
|
||||
BH71 Workstation
|
||||
Settings Configuration Default Permitted Description
|
||||
Value
|
||||
|
||||
Basic Genera Bluetooth 1-on 0-off Turn Bluetooth
|
||||
Settings l 1-on function on or off
|
||||
|
||||
Device Yealink N/A User-defined
|
||||
Name BH71 device Bluetooth
|
||||
Workstati name
|
||||
|
||||
|
||||
126 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
on
|
||||
|
||||
Headset Yealink N/A User-defined
|
||||
Name BH71 headphone name
|
||||
|
||||
Open 1-on 0-off Set whether BH71
|
||||
Discover 1-on Workstation can be
|
||||
searched by other
|
||||
Bluetooth devices
|
||||
|
||||
Discoverab 5min 5min Set the length of
|
||||
le Time 10min time this unit can
|
||||
30min be discovered by
|
||||
60min other Bluetooth
|
||||
Forever devices
|
||||
|
||||
Call 1-on 0-off Set whether to
|
||||
Control 1-on enable USB call
|
||||
With control function
|
||||
Softphone
|
||||
|
||||
Date 0-MMM DD 0-MMM DD Set date display
|
||||
Format 1-DD MMM format
|
||||
|
||||
Time 1-24 Hour 0-12 Hour Set time display
|
||||
Format 1-24 Hour format
|
||||
|
||||
Manual 0-off 0-off Set manual time
|
||||
Time 1-on
|
||||
|
||||
Sound Status 0-Voice 0-Voice Configure prompt
|
||||
Tone Type 1-Tone tone type
|
||||
2-Off
|
||||
|
||||
Voice 0-English 0-English Configure prompt
|
||||
Guidance 1-Chinese voice language
|
||||
Language 2-German
|
||||
3-French
|
||||
4-Spanish
|
||||
5-Italian
|
||||
6-
|
||||
|
||||
|
||||
127 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Portuguese
|
||||
7-Japanese
|
||||
8-Korean
|
||||
9-Dutch
|
||||
|
||||
Keypad 1-on 0-off Set whether to play
|
||||
Tone 1-on key tone
|
||||
|
||||
Second 0-off 0-off Hear notification
|
||||
Device 1-on tones from other
|
||||
Notifcation connected devices
|
||||
Tone while streaming
|
||||
audio
|
||||
|
||||
Sleep Auto Sleep 8h 0-Never Set the time for the
|
||||
Mode 15-15min headset to enter
|
||||
30-30min sleep mode when
|
||||
60-1h there is no device
|
||||
120-2h connection
|
||||
240-4h
|
||||
360-6h
|
||||
480-8h
|
||||
|
||||
PC Headset 0-off 0-off Set whether local
|
||||
Softph Local 1-on ringtones are heard
|
||||
one Ringtone from the headset
|
||||
|
||||
Base 4 Min Set the base
|
||||
Ringtone Number:0 ringtone volume
|
||||
Volume Max for incoming calls
|
||||
Number:15 (0-15)
|
||||
|
||||
Local Ring 0- 0- Select a local
|
||||
Type Ring1.wav Ring1.wav- ringtone for
|
||||
Ring1.wav incoming calls from
|
||||
1- a USB-connected
|
||||
Ring2.wav- device
|
||||
Ring2.wav
|
||||
2-
|
||||
|
||||
|
||||
128 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Ring3.wav-
|
||||
Ring3.wav
|
||||
3-
|
||||
Ring4.wav-
|
||||
Ring4.wav
|
||||
4-
|
||||
Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Deskph Headset 1-on 0-off Set whether local
|
||||
one Local 1-on ringtones are heard
|
||||
Ringtone in the headset
|
||||
when the desk
|
||||
phone receives a
|
||||
call
|
||||
|
||||
Base 4 Min Set the base
|
||||
Ringtone Number:0 ringtone volume
|
||||
Volume Max when the desk
|
||||
Number:15 phone receives a
|
||||
call
|
||||
|
||||
Local Ring 0- 0- Select a local
|
||||
Type Ring1.wav Ring1.wav- ringtone for
|
||||
Ring1.wav incoming calls from
|
||||
1- a USB-connected
|
||||
Ring2.wav- device
|
||||
Ring2.wav
|
||||
2-
|
||||
Ring3.wav-
|
||||
Ring3.wav
|
||||
3-
|
||||
Ring4.wav-
|
||||
Ring4.wav
|
||||
4-
|
||||
Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
129 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Mobile Headset 0-off 0-off Set whether local
|
||||
Device Local 1-on ringtones are heard
|
||||
1 Ringtone in the headset
|
||||
when Bluetooth
|
||||
device 1 receives a
|
||||
call
|
||||
|
||||
Base 4 Min Set the base
|
||||
Ringtone Number:0 ringtone volume
|
||||
Volume Max when Bluetooth
|
||||
Number:15 device 1 receives a
|
||||
call
|
||||
|
||||
Local Ring 0- 0- Select the local
|
||||
Type Ring1.wav Ring1.wav- ringtone for
|
||||
（Default: Ring1.wav incoming calls from
|
||||
Ring1.wa 1- Bluetooth device 1
|
||||
v） Ring2.wav-
|
||||
Ring2.wav
|
||||
2-
|
||||
Ring3.wav-
|
||||
Ring3.wav
|
||||
3-
|
||||
Ring4.wav-
|
||||
Ring4.wav
|
||||
4-
|
||||
Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Mobile Headset 0-off 0-off Set whether local
|
||||
Device Local 1-on ringtones are heard
|
||||
2 Ringtone in the headset
|
||||
when Bluetooth
|
||||
device 2 receives a
|
||||
call
|
||||
|
||||
Base 4 Min Set the base
|
||||
Ringtone Number:0 ringtone volume
|
||||
|
||||
130 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Volume Max when Bluetooth
|
||||
Number:15 device 2 receives a
|
||||
call
|
||||
|
||||
Local Ring 0- 0- Select the local
|
||||
Type Ring1.wav Ring1.wav- ringtone for
|
||||
（Default: Ring1.wav incoming calls from
|
||||
Ring1.wa 1- Bluetooth device 2
|
||||
v） Ring2.wav-
|
||||
Ring2.wav
|
||||
2-
|
||||
Ring3.wav-
|
||||
Ring3.wav
|
||||
3-
|
||||
Ring4.wav-
|
||||
Ring4.wav
|
||||
4-
|
||||
Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Display Light 0-Dark 0-Dark Select LCD visual
|
||||
Themes 1-Light effect, default dark
|
||||
business mode,
|
||||
optional light
|
||||
visual effect
|
||||
|
||||
0-Classic 0-Classic Select LCD visual
|
||||
black black effects, default
|
||||
1-Emerald black business
|
||||
green mode, optional
|
||||
2-Starry light-colored visual
|
||||
purple effects
|
||||
|
||||
Backlight 0-Always 0-Always on If no operation is
|
||||
Time on 1800-30min performed after
|
||||
3600-1h this time, the
|
||||
7200-2h screen will turn off.
|
||||
|
||||
|
||||
131 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
14400-4h
|
||||
21600-6h
|
||||
28800-8h
|
||||
43200-12h
|
||||
|
||||
Backlight 6 Min Set screen
|
||||
Active Number:1 brightness
|
||||
Level Max
|
||||
Number:10
|
||||
|
||||
Screensave 7200-2h 30-30s Display saver wait
|
||||
r Wait 60-1min time
|
||||
Time 120-2min
|
||||
300-5min
|
||||
600-10min
|
||||
900-15min
|
||||
1200-20min
|
||||
1800-30min
|
||||
2700-45min
|
||||
3600-1h
|
||||
7200-2h
|
||||
|
||||
Screensave 0-System 0-System 1- Choose to display
|
||||
r Custom built-in screensaver
|
||||
Backgroun images or custom
|
||||
d screensaver images
|
||||
|
||||
Custom N/A N/A N/A
|
||||
Images
|
||||
|
||||
Busylig Busylight 0 0-Sync Busylight status
|
||||
ht 1-Available configuration
|
||||
2-DND
|
||||
3-Off
|
||||
|
||||
Advanced Genera USB 0-Instant 0-Instant Control how the
|
||||
Settings l Computer 1-Delayed speaker on the
|
||||
Audio 2-Never base plays non-call
|
||||
3-Always audio from the USB
|
||||
|
||||
|
||||
132 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
device when the
|
||||
headset is placed
|
||||
on the base.
|
||||
|
||||
Mute 1-on 0-off After turning it on,
|
||||
Reminder 1-on if the headset is
|
||||
muted during a
|
||||
call, the mute
|
||||
prompt can be
|
||||
heard on the
|
||||
headset
|
||||
|
||||
Mute 20-20s 10-10s After turning on
|
||||
Reminder 20-20s Mute regular
|
||||
Interval 30-30s reminder, the
|
||||
60-1min interval period of
|
||||
120-2min the regular
|
||||
300-5min reminder
|
||||
600-10mn
|
||||
1800-30min
|
||||
|
||||
Environme 0- 0-Adaptive You can use this
|
||||
nt Adaptive 1-Noise configuration to
|
||||
Adaptation Environmen adjust the headset
|
||||
t performance in
|
||||
2-Quiet different usage
|
||||
Environmen environments
|
||||
t
|
||||
3.-Off
|
||||
|
||||
Platform None Teams- Select the platform
|
||||
Teams based on the
|
||||
Platform environment
|
||||
UC-UC variables burned
|
||||
Platform by the tool
|
||||
|
||||
Calling Call Device 0- 0-Automatic Select default
|
||||
Automatic 1-PC calling device
|
||||
|
||||
|
||||
133 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Softphone
|
||||
2-
|
||||
Deskphone
|
||||
3-Mobile
|
||||
device1
|
||||
4-Mobile
|
||||
device2
|
||||
|
||||
PC Call None Dynamic Set PC software call
|
||||
Device enumeration control focus
|
||||
and display
|
||||
of software
|
||||
terminals
|
||||
recognized
|
||||
by SDK/API
|
||||
|
||||
Call 2-New call 1-Current After setting the
|
||||
Priority call priority of multiple
|
||||
2-New call calls after
|
||||
answering a new
|
||||
call during a call,
|
||||
the terminal device
|
||||
needs to be picked
|
||||
up to take effect.
|
||||
|
||||
Phone 0-Normal 0-Normal Compatible with
|
||||
Type 1-Unify unify phone
|
||||
configuration,
|
||||
switch report
|
||||
descriptor
|
||||
|
||||
Auto 1-on 0-off 1-on Set whether the
|
||||
Answer headset
|
||||
when automatically
|
||||
Undocked answers incoming
|
||||
calls when
|
||||
removed from the
|
||||
|
||||
|
||||
134 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
base
|
||||
|
||||
Open Line 0-off 0-off Set whether the
|
||||
when 1-on headset will
|
||||
Undocked automatically go
|
||||
off-hook when
|
||||
removed from the
|
||||
base in standby
|
||||
mode
|
||||
|
||||
Equalizer 0-Normal 0-Normal Call audio
|
||||
for Calls 1-Bass equalizer settings
|
||||
2-Treble
|
||||
|
||||
Comfort 1-on 0-off The local call is
|
||||
Noise 1-on Mute, and a weak
|
||||
comfortable noise
|
||||
is added to remind
|
||||
the other party that
|
||||
the call is online.
|
||||
|
||||
Noise 1-on 0-off Set whether to turn
|
||||
Suppressi 1-on on the
|
||||
on environmental
|
||||
noise cancellation
|
||||
function
|
||||
|
||||
Smart 0-off 0-off 1-on Set whether to
|
||||
Noise enable intelligent
|
||||
Block ambient noise
|
||||
cancellation
|
||||
|
||||
Hearing Anti- 0-Peak 0-Peak Set hearing
|
||||
Startle Block Block protection mode
|
||||
Protect Protection Protection Protection
|
||||
ion 1-Australian
|
||||
G616
|
||||
Protection
|
||||
|
||||
Daily Noise 0-No 0-No Set the sound
|
||||
|
||||
135 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Exposure Limiting Limiting pressure level to be
|
||||
1-80dBA retained on noise
|
||||
2-85dBA days
|
||||
|
||||
Daily Noise 8-8 hours 2-2 hours Set daily
|
||||
Exposure 4-4 hours headphone usage
|
||||
Time 6-6 hours amount
|
||||
8-8 hours
|
||||
|
||||
BH72&BH76
|
||||
Settings Configuration Default Permitted Description
|
||||
Value
|
||||
|
||||
Basic General Device Yealink N/A User-defined
|
||||
Settings Name BH72/ device
|
||||
Yealink Bluetooth
|
||||
BH76/ name, effective
|
||||
Yealink immediately
|
||||
BH76 Plus after
|
||||
modification
|
||||
|
||||
Headset Voice 0-English 0-English Set voice
|
||||
Guidance Guidance 1-Chinese prompt
|
||||
Language language
|
||||
|
||||
Keypad 1-on 0-off Refers to
|
||||
Tone 1-on whether you
|
||||
want to hear a
|
||||
beep when
|
||||
pressing the
|
||||
button
|
||||
|
||||
Status Tone 1-Voice 0-Tone When
|
||||
Type prompt prompt interacting
|
||||
1-Voice with the
|
||||
prompt headset, is
|
||||
"speech" or
|
||||
"simple scale"
|
||||
|
||||
|
||||
136 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
played?
|
||||
|
||||
Status Tone 8 Min When
|
||||
Volume Number:0 interacting
|
||||
Max with the
|
||||
Number:1 headset,
|
||||
5 announce the
|
||||
volume level
|
||||
|
||||
Second 0-Play first 0-Play first Hear the audio
|
||||
Device priority priority (tone & music)
|
||||
Audio 1-Last from the other
|
||||
playback connected
|
||||
priority device while
|
||||
streaming
|
||||
audio
|
||||
|
||||
MFB Button 1-Music 1-Music MFB function
|
||||
play/pause play/ configuration
|
||||
pause switch
|
||||
0-Dial
|
||||
function
|
||||
|
||||
PC Call None Dynamic Set PC
|
||||
Device enumerati software call
|
||||
on and control focus
|
||||
display of
|
||||
software
|
||||
terminals
|
||||
recognized
|
||||
by SDK/
|
||||
API
|
||||
|
||||
Mute Smart Mute 1-on 0-off After turning it
|
||||
Reminder Reminder 1-on on, if the
|
||||
headset is
|
||||
muted during a
|
||||
call, the
|
||||
|
||||
|
||||
137 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
microphone
|
||||
will detect that
|
||||
you are
|
||||
speaking and
|
||||
will issue a
|
||||
mute
|
||||
reminder.
|
||||
|
||||
Mute 10-30s 10-10s After turning
|
||||
Detection 20-20s on Mute
|
||||
Interval 30-30s regular
|
||||
reminder, the
|
||||
interval period
|
||||
of the regular
|
||||
reminder
|
||||
|
||||
Smart Auto Answer 1-on 0-off When the
|
||||
Sensor 1-on headset
|
||||
receives a call,
|
||||
pull out the
|
||||
straw to
|
||||
automatically
|
||||
answer the
|
||||
call.
|
||||
|
||||
Auto Play/ 1-on 0-off When music is
|
||||
Pause 1-on playing, you
|
||||
can
|
||||
automatically
|
||||
pause
|
||||
playback by
|
||||
taking off and
|
||||
wearing
|
||||
headphones.
|
||||
|
||||
Advanced General Platform Teams- Teams- Choose to use
|
||||
Settings TeamsPlatf Teams UC platform or
|
||||
|
||||
|
||||
138 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
orm Platform Teams
|
||||
UC-UC platform
|
||||
Platform
|
||||
|
||||
Calling Environment 0-Adaptive 0- You can use
|
||||
Adaptation Adaptive this
|
||||
1-Noise configuration
|
||||
Environme to adjust the
|
||||
nt vocal effect
|
||||
2-Quiet heard by the
|
||||
Environme other party
|
||||
nt during the call.
|
||||
3-Off
|
||||
|
||||
Sidetone 8 45306 This setting
|
||||
Level allows you to
|
||||
adjust how
|
||||
loud your voice
|
||||
is heard during
|
||||
calls
|
||||
|
||||
Hearing Anti-Startle 0-Peak 0-Peak Select to
|
||||
Protection Protection Block Block automatically
|
||||
Protection Protection ajust the
|
||||
1- volume level in
|
||||
Australian the headset to
|
||||
G616 limit your daily
|
||||
Protection exposure to
|
||||
excessive
|
||||
audio volume.
|
||||
The headset
|
||||
always
|
||||
provides
|
||||
protection
|
||||
against sound
|
||||
spikes
|
||||
|
||||
|
||||
|
||||
139 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Daily Noise 0-No 0-No Select the
|
||||
Exposure Limiting Limiting decibel level
|
||||
1-80dBA above which
|
||||
2-85dBA the headset
|
||||
protects
|
||||
against sound
|
||||
spikes
|
||||
|
||||
Daily Noise 8-8 hours 2-2 hours Set the
|
||||
Exposure 4-4 hours number of
|
||||
Time 6-6 hours daily call hours
|
||||
8-8 hours for the
|
||||
headset.
|
||||
Improve the
|
||||
accuracy of the
|
||||
Daily Noise
|
||||
Exposure
|
||||
setting by
|
||||
choosing a
|
||||
value that best
|
||||
represents
|
||||
headphone
|
||||
usage
|
||||
|
||||
Moments Ambient Ear Cushion On Ear On Ear Switch the
|
||||
Sound Customizati Over Ear earmuff style
|
||||
on and take effect
|
||||
on the
|
||||
corresponding
|
||||
audio
|
||||
parameters of
|
||||
the earphones
|
||||
|
||||
Ambient 0-High Level 0-High Ambient sound
|
||||
Sound ANC Level ANC parameter
|
||||
Settings 1-Medium settings
|
||||
Level ANC
|
||||
|
||||
140 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2-Fully
|
||||
transparen
|
||||
t
|
||||
|
||||
Warning Do Not 1-On 0-off When a new
|
||||
light Disturb in- 1-on call comes in,
|
||||
call the headset
|
||||
automatically
|
||||
turns on the
|
||||
busy indicator
|
||||
light
|
||||
|
||||
Busylight 0-Off 0-off Manually
|
||||
1-on toggle the busy
|
||||
light switch
|
||||
|
||||
WH62&WH63
|
||||
Settings Configuration Defau Permitted Description
|
||||
lt Value
|
||||
|
||||
Basic General Busylight 0-off 0-Sync Busylight status
|
||||
Settings 1-Available configuration
|
||||
2-DND
|
||||
3-Off
|
||||
|
||||
Sound Keypad 1-on 0-off Set whether to play key
|
||||
Tone 1-on tone
|
||||
|
||||
Wearing 0- 0-Boom Arm Switch the left and
|
||||
Preference Boom on Right right channels of the
|
||||
Arm Side headset
|
||||
on 1-Boom Arm
|
||||
Right on Left Side
|
||||
Side
|
||||
|
||||
PC Call Control 1-on 0-off Set whether to enable
|
||||
Softpho with 1-on USB call control
|
||||
ne Softphone function
|
||||
|
||||
Headset 0-off 0-off Set whether local
|
||||
|
||||
141 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Local 1-on ringtones are heard
|
||||
Ringtone from the headset
|
||||
|
||||
Base 8 Min Set the base ringtone
|
||||
Ringtone Number:0 volume for incoming
|
||||
Volume Max calls (0-15)
|
||||
Number:15
|
||||
|
||||
Local Ring 0- 0-Ring1.wav- Select a local ringtone
|
||||
Type Ring1 Ring1.wav for incoming calls from
|
||||
.wav 1-Ring2.wav- a USB-connected
|
||||
Ring2.wav, device
|
||||
|
||||
Deskph Headset 0-off 0-off Set whether local
|
||||
one Local 1-on ringtones are heard in
|
||||
Ringtone the headset when the
|
||||
desk phone receives a
|
||||
call
|
||||
|
||||
Base 8 Min Set the base ringtone
|
||||
Ringtone Number:0 volume when the desk
|
||||
Volume Max phone receives a call
|
||||
Number:15
|
||||
|
||||
Local Ring 0- 0-Ring1.wav- Select a local ringtone
|
||||
Type Ring1 Ring1.wav for incoming calls from
|
||||
.wav 1-Ring2.wav- a USB-connected
|
||||
Ring2.wav, device
|
||||
|
||||
Advanced General Audio 2- 1- Sound transmission
|
||||
Settings Bandwidth Wide Narrowban bandwidth
|
||||
band d， configuration
|
||||
2-Wideband
|
||||
|
||||
Wireless 1- 1-Long Set DECT wireless
|
||||
Range Long 2-Medium distance/transmit
|
||||
3-Short power
|
||||
|
||||
Voice 1-on 0-off Set whether to enable
|
||||
Guidance 1-on voice prompts
|
||||
|
||||
|
||||
|
||||
142 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Voice 0- 0-English Configure prompt
|
||||
Guidance Englis 2-Deutsch voice language
|
||||
Language h 3-French
|
||||
4-Spanish
|
||||
25-Follow
|
||||
Screen
|
||||
Language
|
||||
|
||||
Mute 1-on 0-off 1-on After turning it on, if
|
||||
Reminder the headset is muted
|
||||
during a call, the mute
|
||||
prompt can be heard
|
||||
on the headset
|
||||
|
||||
Mute 20-20 10-10s After turning on Mute
|
||||
Reminder s 20-20s regular reminder, the
|
||||
Interval 30-30s interval period of the
|
||||
60-1min regular reminder
|
||||
120-2min
|
||||
300-5min
|
||||
600-10mn
|
||||
1800-30min
|
||||
|
||||
USB 0- 0-Instant Control how the
|
||||
Computer Instan 1-Delayed speaker on the base
|
||||
Audio t 2-Never plays non-call audio
|
||||
3-Always from the USB device
|
||||
when the headset is
|
||||
placed on the base.
|
||||
|
||||
Environment 0- 0-Quiet Switch different audio
|
||||
Adaptation Quiet Environment parameters for
|
||||
Envir 1-Noise different send volumes
|
||||
onme Environment
|
||||
nt
|
||||
|
||||
Music Mode 1-on 0-off Turn this option on to
|
||||
1-on optimize the audio
|
||||
|
||||
|
||||
143 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
experience for your
|
||||
music. The audio
|
||||
quality of calls is not
|
||||
affected by this setting
|
||||
|
||||
Call Call Device 1- 1-Desk Select default calling
|
||||
Desk phone device
|
||||
phon 2-Soft Phone
|
||||
e
|
||||
|
||||
PC Call None Configuratio Default soft client
|
||||
Device n on PC outbound call
|
||||
configuration
|
||||
|
||||
Call Priority 2- 1-Current After setting the
|
||||
New call priority of multiple
|
||||
call 2-New call calls after answering a
|
||||
new call during a call,
|
||||
the terminal device
|
||||
needs to be picked up
|
||||
to take effect.
|
||||
|
||||
MFB Once 1- 0-End Technical support is
|
||||
to Second Answe current call integrated, and the
|
||||
Call r new only logic of picking up new
|
||||
incom 1-Answer calls during a call is
|
||||
ing new
|
||||
call incoming
|
||||
call
|
||||
|
||||
Call 0-off 0-off After turning it on, the
|
||||
Recording 1-on computer-side
|
||||
recording software
|
||||
connected through
|
||||
USB (PC) records the
|
||||
call sound of terminals
|
||||
other than this
|
||||
connection.
|
||||
|
||||
|
||||
144 / 197
|
||||
@@ -0,0 +1,840 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 501-520
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 501-520 of 953
|
||||
**Chunk:** 26
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Phone Type 0- 0-Normal Compatible with unify
|
||||
Norma 1-Unify phone configuration,
|
||||
l switch report
|
||||
descriptor
|
||||
|
||||
Auto 1-on 0-off Set whether the
|
||||
Answer 1-on headset automatically
|
||||
when answers incoming calls
|
||||
Undocked when removed from
|
||||
the base
|
||||
|
||||
Open Line 1-on 0-off Set whether the
|
||||
when 1-on headset will
|
||||
Undocked automatically go off-
|
||||
hook when removed
|
||||
from the base in
|
||||
standby mode
|
||||
|
||||
Headset 1-on 0-off When turned on, the
|
||||
Busylight 1-on indicator light on the
|
||||
headset will indicate
|
||||
the call status
|
||||
|
||||
Permanent 0-off 0-off Multi-headset
|
||||
Conference 1-on permanent conference
|
||||
Mode mode
|
||||
|
||||
Equalizer 0- 0-Normal Call audio equalizer
|
||||
for Calls Norma 1-Bass settings
|
||||
l 2-Treble
|
||||
|
||||
Comfort 1-on 0-off The local call is Mute,
|
||||
Noise 1-on and a weak
|
||||
comfortable noise is
|
||||
added to remind the
|
||||
other party that the
|
||||
call is online.
|
||||
|
||||
Hearing Anti-Startle 0- 0-Peak Block Set hearing protection
|
||||
Protecti Protection Peak Protection mode
|
||||
|
||||
145 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
on Block 1-Australian
|
||||
Protec G616
|
||||
tion Protection
|
||||
|
||||
Daily Noise 0-No 0-No Set the sound pressure
|
||||
Exposure Limiti Limiting level to be retained on
|
||||
ng 1-80dBA noise days
|
||||
2-85dBA
|
||||
|
||||
Daily Noise 8-8小 2-2 hours Set daily headphone
|
||||
Exposure 时 4-4 hours usage amount
|
||||
Time 6-6 hours
|
||||
8-8 hours
|
||||
|
||||
WH62 Portable & WH63 Portable
|
||||
Settings Configuration Default Permitted Description
|
||||
Value
|
||||
|
||||
Basic Sound Keypad 1-on 0-off Set whether to play
|
||||
Settings Tone 1-on key tone
|
||||
|
||||
Speaker 8 Min Set local default
|
||||
Volume Number:0 playback volume
|
||||
Max
|
||||
Number:15
|
||||
|
||||
PC Call 1-on 0-off Set whether to enable
|
||||
Softph Control 1-on USB call control
|
||||
one with function
|
||||
Softphone
|
||||
|
||||
Headset 0-off 0-off Set whether local
|
||||
Local 1-on ringtones are heard
|
||||
Ringtone from the headset
|
||||
|
||||
Deskp Headset 0-off 0-off Set whether local
|
||||
hone Local 1-on ringtones are heard in
|
||||
Ringtone the headset when the
|
||||
desk phone receives a
|
||||
call
|
||||
|
||||
146 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Advanced Genera Audio 2- 1- Sound transmission
|
||||
Settings l Bandwidt Wideba Narrowband bandwidth
|
||||
h nd 2-Wideband configuration
|
||||
|
||||
Wireless 1-Long 1-Long Set DECT wireless
|
||||
Range 2-Medium distance/transmit
|
||||
3-Short power
|
||||
|
||||
Voice 1-on 0-off Set whether to enable
|
||||
Guidance 1-on voice prompts
|
||||
|
||||
Voice 0- 0-English Configure prompt
|
||||
Guidance English 2-Deutsch voice language
|
||||
Language 3-French
|
||||
4-Spanish
|
||||
25-Follow
|
||||
Screen
|
||||
Language
|
||||
|
||||
Mute 1-on 0-off After turning it on, if
|
||||
Reminder 1-on the headset is muted
|
||||
during a call, the mute
|
||||
prompt can be heard
|
||||
on the headset
|
||||
|
||||
Mute 20-20s 10-10s After turning on Mute
|
||||
Reminder 20-20s regular reminder, the
|
||||
Interval 30-30s interval period of the
|
||||
60-1min regular reminder
|
||||
120-2min
|
||||
300-5min
|
||||
600-10mn
|
||||
1800-30min
|
||||
|
||||
USB 0- 0-Instant Control how the
|
||||
Computer Instant 1-Delayed speaker on the base
|
||||
Audio 2-Never plays non-call audio
|
||||
3-Always from the USB device
|
||||
when the headset is
|
||||
|
||||
|
||||
147 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
placed on the base.
|
||||
|
||||
Music 1-on 0-off Turn this option on to
|
||||
Mode 1-on optimize the audio
|
||||
experience for your
|
||||
music. The audio
|
||||
quality of calls is not
|
||||
affected by this setting
|
||||
|
||||
Platform None None-Teams Select the platform
|
||||
platform, based on the
|
||||
there is no environment variables
|
||||
such burned by the tool.
|
||||
configuration The default
|
||||
item in the configuration is empty.
|
||||
LCD setting
|
||||
interface.
|
||||
Teams-
|
||||
Teams
|
||||
Platform
|
||||
UC-UC
|
||||
platform
|
||||
|
||||
Call PC Call None Configuration Default soft client
|
||||
Device on PC outbound call
|
||||
configuration
|
||||
|
||||
Auto 1-on 0-off Set whether the
|
||||
Answer 1-on headset automatically
|
||||
when answers incoming calls
|
||||
Undocked when removed from
|
||||
the base
|
||||
|
||||
Open Line 1-on 0-off Set whether the
|
||||
when 1-on headset will
|
||||
Undocked automatically go off-
|
||||
hook when removed
|
||||
from the base in
|
||||
|
||||
|
||||
148 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
standby mode
|
||||
|
||||
Headset 1-on 0-off When turned on, the
|
||||
Busylight 1-on indicator light on the
|
||||
headset will indicate
|
||||
the call status
|
||||
|
||||
Equalizer 0- 0-Normal Call audio equalizer
|
||||
for Calls Normal 1-Bass settings
|
||||
2-Treble
|
||||
|
||||
Comfort 1-on 0-off The local call is Mute,
|
||||
Noise 1-on and a weak
|
||||
comfortable noise is
|
||||
added to remind the
|
||||
other party that the
|
||||
call is online.
|
||||
|
||||
Hearin Anti- 0-Peak 0-Peak Block Set hearing protection
|
||||
g Startle Block Protection mode
|
||||
Protec Protection Protect 1-Australian
|
||||
tion ion G616
|
||||
Protection
|
||||
|
||||
Daily 0-No 0-No Set the sound pressure
|
||||
Noise Limitin Limiting level to be retained on
|
||||
Exposure g 1-80dBA noise days
|
||||
2-85dBA
|
||||
|
||||
Daily 8-8 2-2 hours Set daily headphone
|
||||
Noise hours 4-4 hours usage amount
|
||||
Exposure 6-6 hours
|
||||
Time 8-8 hours
|
||||
|
||||
WH66&WH67
|
||||
Sett Configuratio Default Permitted Description
|
||||
ings n Value
|
||||
|
||||
Basic Gener Bluet 0-off 0-off Turn Bluetooth function on
|
||||
al ooth 1-on or off
|
||||
|
||||
149 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Sett Devic Yealink N/A User-defined device
|
||||
ings e WH66/67 Bluetooth name
|
||||
Nam
|
||||
e
|
||||
|
||||
Disco 300-5min 0-Forever Set the length of time this
|
||||
verab 300-5min unit can be discovered by
|
||||
le 600-10min other Bluetooth devices
|
||||
Time 1800-30min
|
||||
3600-60min
|
||||
|
||||
Call 1-on 0-off Set whether to enable USB
|
||||
Contr 1-on call control function
|
||||
ol
|
||||
with
|
||||
Soft
|
||||
phon
|
||||
e
|
||||
|
||||
Date 0-MMM DD 0-MMM DD Set date display format
|
||||
Form 1-DD MMM
|
||||
at
|
||||
|
||||
Time 1-24 Hour 0-12 Hour Set time display format
|
||||
Form 1-24 Hour
|
||||
at
|
||||
|
||||
Busyl 0-off 0-Sync Busylight status
|
||||
ight 1-Available configuration
|
||||
2-DND
|
||||
3-Off
|
||||
|
||||
Soun Dial 1-on 0-off Set whether to sound the
|
||||
d Tone 1-on connection pre-dial tone
|
||||
after entering the dial pad
|
||||
|
||||
Keypa 1-on 0-off Set whether to play key tone
|
||||
d 1-on
|
||||
Tone
|
||||
|
||||
Weari 0-Boom Arm 0-Boom Arm on Switch the left and right
|
||||
|
||||
150 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
ng on Right Right Side channels of the headset
|
||||
Prefe Side 1-Boom Arm on
|
||||
rence Left Side
|
||||
|
||||
PC Heads 0-off 0-off Set whether local ringtones
|
||||
Soft et 1-on are heard from the headset
|
||||
phon Local
|
||||
e Ringt
|
||||
one
|
||||
|
||||
Base 8 Min Number:0, Set the base ringtone
|
||||
Ringt Max Number:15 volume for incoming calls
|
||||
one (0-15)
|
||||
Volu
|
||||
me
|
||||
|
||||
Local 0-Ring1.wav 0-Ring1.wav- Select a local ringtone for
|
||||
Ring Ring1.wav incoming calls from a USB-
|
||||
Type 1-Ring2.wav- connected device
|
||||
Ring2.wav
|
||||
2-Ring3.wav-
|
||||
Ring3.wav
|
||||
3-Ring4.wav-
|
||||
Ring4.wav
|
||||
4-Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Desk Heads 0-off 0-off Set whether local ringtones
|
||||
phon et 1-on are heard in the headset
|
||||
e Local when the desk phone
|
||||
Ringt receives a call
|
||||
one
|
||||
|
||||
Base 8 Min Number:0 Set the base ringtone
|
||||
Ringt Max Number:15 volume when the desk
|
||||
one phone receives a call
|
||||
Volu
|
||||
me
|
||||
|
||||
|
||||
151 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Local 0-Ring1.wav 0-Ring1.wav- Select a local ringtone for
|
||||
Ring Ring1.wav incoming calls from a USB-
|
||||
Type 1-Ring2.wav- connected device
|
||||
Ring2.wav
|
||||
2-Ring3.wav-
|
||||
Ring3.wav
|
||||
3-Ring4.wav-
|
||||
Ring4.wav
|
||||
4-Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Mobil Heads 0-off 0-off Set whether local ringtones
|
||||
e et 1-on are heard in the headset
|
||||
Devic Local when Bluetooth device 1
|
||||
e1 Ringt receives a call
|
||||
one
|
||||
|
||||
Base 8 Min Number:0 Set the base ringtone
|
||||
Ringt Max Number:15 volume when Bluetooth
|
||||
one device 1 receives a call
|
||||
Volu
|
||||
me
|
||||
|
||||
Local 0-Ring1.wav 0-Ring1.wav- Select the local ringtone for
|
||||
Ring Ring1.wav incoming calls from
|
||||
Type 1-Ring2.wav- Bluetooth device 1
|
||||
Ring2.wav
|
||||
2-Ring3.wav-
|
||||
Ring3.wav
|
||||
3-Ring4.wav-
|
||||
Ring4.wav
|
||||
4-Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Mobil Heads 0-off 0-off Set whether local ringtones
|
||||
e et 1-on are heard in the headset
|
||||
Devic Local when Bluetooth device 2
|
||||
e2 Ringt receives a call
|
||||
|
||||
152 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
one
|
||||
|
||||
Base 8 Min Number:0 Set the base ringtone
|
||||
Ringt Max Number:15 volume when Bluetooth
|
||||
one device 2 receives a call
|
||||
Volu
|
||||
me
|
||||
|
||||
Local 0-Ring1.wav 0-Ring1.wav- Select the local ringtone for
|
||||
Ring Ring1.wav incoming calls from
|
||||
Type 1-Ring2.wav- Bluetooth device 2
|
||||
Ring2.wav
|
||||
2-Ring3.wav-
|
||||
Ring3.wav
|
||||
3-Ring4.wav-
|
||||
Ring4.wav
|
||||
4-Ring5.wav-
|
||||
Ring5.wav
|
||||
|
||||
Displ Dark 0-off 0-off After turning it on, the
|
||||
ay Them 1-on background color will
|
||||
e change to a dark tone,
|
||||
suitable for night mode
|
||||
(only under Teams version
|
||||
UI)
|
||||
|
||||
Team 0-个人模式 0-Personal Choose whether to continue
|
||||
s Mode selecting Teams account
|
||||
User 1-Hot Desking information after removing
|
||||
Nam Mode the device. It will continue
|
||||
e to be displayed in personal
|
||||
mode, and will not be
|
||||
displayed in mobile office
|
||||
mode (only under Teams
|
||||
version UI)
|
||||
|
||||
Backl 6 Min Number:1 Set screen brightness
|
||||
ight Max Number:10
|
||||
|
||||
|
||||
153 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Active
|
||||
Level
|
||||
|
||||
Backl 0-Always on 0-Always on If no operation is performed
|
||||
ight 1800-30min after this time, the screen
|
||||
Time 3600-1h will turn off.
|
||||
7200-2h
|
||||
14400-4h
|
||||
21600-6h
|
||||
28800-8h
|
||||
43200-12h
|
||||
|
||||
Scree 7200-2h 30-30s Display saver wait time
|
||||
nsave 60-1min
|
||||
r Wait 120-2min
|
||||
Time 300-5min
|
||||
600-10min
|
||||
900-15min
|
||||
1200-20min
|
||||
1800-30min
|
||||
2700-45min
|
||||
3600-1h
|
||||
7200-2h
|
||||
|
||||
Scree 0-System 0-System Choose to display built-in
|
||||
nsave 1-Custom screensaver images or
|
||||
r custom screensaver images
|
||||
Back
|
||||
grou
|
||||
nd
|
||||
|
||||
Cust
|
||||
om
|
||||
Imag
|
||||
es
|
||||
|
||||
Them /phone/ /phone/ Set LCD theme style (only in
|
||||
es resource/ resource/ UC mode).
|
||||
|
||||
|
||||
154 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
system/ system/theme/ 5 themes are available, the
|
||||
theme/UC/ UC/cardbg/ default is the first theme
|
||||
cardbg/ card_big_1.png-
|
||||
card_big_1. Light theme 1
|
||||
png /phone/
|
||||
resource/
|
||||
system/theme/
|
||||
UC/cardbg/
|
||||
card_big_2.png-
|
||||
Light theme 2
|
||||
/phone/
|
||||
resource/
|
||||
system/theme/
|
||||
UC/cardbg/
|
||||
card_big_3.png-
|
||||
Light theme 3
|
||||
/phone/
|
||||
resource/
|
||||
system/theme/
|
||||
UC/cardbg/
|
||||
card_big_4.png-
|
||||
Light theme 4
|
||||
/phone/
|
||||
resource/
|
||||
system/theme/
|
||||
UC/cardbg/
|
||||
card_big_5.png-
|
||||
Dark theme
|
||||
|
||||
Adva Gener Audio 2-Wideband 1-Narrowband Sound transmission
|
||||
nced al 2-Wideband bandwidth configuration
|
||||
Band
|
||||
Sett width
|
||||
ings Wirel 1-Long 1-Long Set DECT wireless distance/
|
||||
ess 2-Medium transmit power
|
||||
|
||||
|
||||
155 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Rang 3-Short
|
||||
e
|
||||
|
||||
Voice 1-on 0-off Set whether to enable voice
|
||||
Guid 1-on prompts
|
||||
ance
|
||||
|
||||
Voice 0-English 0-English Configure prompt voice
|
||||
Guida 2-Deutsch language
|
||||
nce 3-French
|
||||
Lang 4-Spanish
|
||||
uage 25-Follow
|
||||
Screen
|
||||
Language
|
||||
|
||||
Mute 1-on 0-off After turning it on, if the
|
||||
Remi 1-on headset is muted during a
|
||||
nder call, the mute prompt can
|
||||
be heard on the headset
|
||||
|
||||
Mute 20-20s 10-10s After turning on Mute
|
||||
Remin 20-20s regular reminder, the
|
||||
der 30-30s interval period of the regular
|
||||
Interv 60-1min reminder
|
||||
al 120-2min
|
||||
300-5min
|
||||
600-10mn
|
||||
1800-30min
|
||||
|
||||
USB 0-Instant 0-Instant Control how the speaker on
|
||||
Comp 1-Delayed the base plays non-call
|
||||
uter 2-Never audio from the USB device
|
||||
Audi 3-Always when the headset is placed
|
||||
o on the base.
|
||||
|
||||
Audio 0-Speaker 0-Speaker Whether to play music on-
|
||||
Play 1-Headset hook hands-free when
|
||||
when music is playing
|
||||
Dock
|
||||
|
||||
|
||||
156 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
ed
|
||||
|
||||
Envir 0-Quiet 0-Quiet Switch different audio
|
||||
onme Environmen Environment 1- parameters for different
|
||||
nt t Noise send volumes
|
||||
Adapt Environment
|
||||
ation
|
||||
|
||||
Music 1-on 0-off Turn this option on to
|
||||
Mode 1-on optimize the audio
|
||||
experience for your music.
|
||||
The audio quality of calls is
|
||||
not affected by this setting
|
||||
|
||||
Platf None None-Teams Select the platform based
|
||||
orm platform, there on the environment
|
||||
is no such variables burned by the tool.
|
||||
configuration The default configuration is
|
||||
item in the LCD empty.
|
||||
setting interface
|
||||
Teams-Teams
|
||||
Platform
|
||||
UC-UC platform
|
||||
|
||||
Calli Call 0-Automatic 0-Automatic Select default calling device
|
||||
ng Devic 1-PC Softphone
|
||||
e 2-Mobile
|
||||
device1
|
||||
3-Mobile
|
||||
device2
|
||||
|
||||
PC None Configuration Default soft client outbound
|
||||
Call on PC call configuration
|
||||
Devic
|
||||
e
|
||||
|
||||
Call 2-New call 1-Current call After setting the priority of
|
||||
Priori 2-New call multiple calls after
|
||||
ty answering a new call during
|
||||
|
||||
|
||||
157 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
a call, the terminal device
|
||||
needs to be picked up to
|
||||
take effect.
|
||||
|
||||
MFB 1-Answer 0-End current Technical support is
|
||||
Once new call only integrated, and the logic of
|
||||
to incoming 1-Answer new picking up new calls during
|
||||
Secon call incoming call a call is
|
||||
d Call
|
||||
|
||||
Call 0-off 0-off After turning it on, the
|
||||
Recor 1-on computer-side recording
|
||||
ding software connected through
|
||||
USB (PC) records the call
|
||||
sound of terminals other
|
||||
than this connection.
|
||||
|
||||
Phon 0-Normal 0-Normal Compatible with unify
|
||||
e 1-Unify phone configuration, switch
|
||||
Type report descriptor
|
||||
|
||||
Auto 0-off 0-off Set whether to turn on the
|
||||
Dial 1-on automatic outgoing call
|
||||
function.
|
||||
After opening: the dial pad
|
||||
will automatically dial out 5
|
||||
seconds after entering the
|
||||
number.
|
||||
|
||||
Auto 1-on 0-off Set whether the headset
|
||||
Answe 1-on automatically answers
|
||||
r incoming calls when
|
||||
when removed from the base
|
||||
Undo
|
||||
cked
|
||||
|
||||
Open 0-off 0-off Set whether the headset will
|
||||
Line 1-on automatically go off-hook
|
||||
when when removed from the
|
||||
|
||||
|
||||
158 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Undo base in standby mode
|
||||
cked
|
||||
|
||||
Hands 0-off 0-off Whether to automatically
|
||||
free 1-on switch to hands-free when
|
||||
when hanging up during a call
|
||||
Dock
|
||||
ed
|
||||
|
||||
Heads 1-on 0-off When turned on, the
|
||||
et 1-on indicator light on the
|
||||
Busyl headset will indicate the call
|
||||
ight status
|
||||
|
||||
Perm 0-off 0-off Multi-headset permanent
|
||||
anent 1-on conference mode
|
||||
|
||||
|
||||
Confe
|
||||
rence
|
||||
Mode
|
||||
|
||||
Equal 0-Normal 0-Normal Call audio equalizer settings
|
||||
izer 1-Bass
|
||||
for 2-Treble
|
||||
Calls
|
||||
|
||||
Comfo 1-on 0-off The local call is Mute, and a
|
||||
rt 1-on weak comfortable noise is
|
||||
Noise added to remind the other
|
||||
party that the call is online.
|
||||
|
||||
Noise 1-on 0-off Set whether to turn on the
|
||||
Suppr 1-on environmental noise
|
||||
essio cancellation function
|
||||
n
|
||||
|
||||
Smart 0-off 0-off Set whether to enable
|
||||
1-on intelligent ambient noise
|
||||
Noise cancellation
|
||||
Block
|
||||
|
||||
159 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Heari Anti- 0-Peak 0-Peak Block Set hearing protection
|
||||
ng Startl Block Protection mode
|
||||
Prote e Protection 1-Australian
|
||||
ction Prote G616 Protection
|
||||
ction
|
||||
|
||||
Daily 0-No 0-No Limiting Set the sound pressure level
|
||||
Noise Limiting 1-80dBA to be retained on noise days
|
||||
Expos 2-85dBA
|
||||
ure
|
||||
|
||||
Daily 8-8 hours 2-2 hours Set daily headphone usage
|
||||
Noise 4-4 hours amount
|
||||
Expos 6-6 hours
|
||||
ure 8-8 hours
|
||||
Time
|
||||
|
||||
|
||||
|
||||
|
||||
Software Configuration
|
||||
Introduction
|
||||
Click the site to display the YUC configuration of the site. After saving, the configuration
|
||||
effects will take effect on the current site and all subordinate sites.
|
||||
|
||||
💡 NOTE
|
||||
For more information about configuring a single YUC, see Single Configuration.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Configuration > Software Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
160 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Configuration
|
||||
Configuratio Description
|
||||
n
|
||||
|
||||
Notification Receive notifications about available updates by message popups.
|
||||
for Yealink
|
||||
💡 NOTE
|
||||
USB Connect
|
||||
Once enabled, this configuration will be locked and cannot be
|
||||
update
|
||||
personally modified by users.
|
||||
|
||||
|
||||
Launch Yealink USB Connect will automatically launch when the PC is started.
|
||||
Yealink USB
|
||||
💡 NOTE
|
||||
Connect
|
||||
Once enabled, this configuration will be locked and cannot be
|
||||
during PC
|
||||
personally modified by users.
|
||||
startup
|
||||
|
||||
YUC receives When enabled, users will be able to receive official updates of the latest
|
||||
official versions through Yealink USB Connect. They can also manually check for
|
||||
version updates on the 'About' page of the software, and this does not conflict
|
||||
update with the operation of enterprise's bulk upgrade tasks.
|
||||
notifications
|
||||
|
||||
USB device When enabled, users can receive official firmware updates for the latest
|
||||
receives version of USB devices through Yealink USB Connect. Users can perform
|
||||
|
||||
161 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
official the upgrade on the "Device Upgrade" page.
|
||||
firmware
|
||||
version
|
||||
update
|
||||
notifications
|
||||
|
||||
Automatically After receiving the official version update notification, if no action is
|
||||
update to the taken to delay or execute immediately within 5 minutes, the upgrade
|
||||
official latest process will automatically commence.
|
||||
version
|
||||
💡 NOTE
|
||||
This item can only be configured when either of the two
|
||||
configuration options, "YUC receives official version update
|
||||
notifications" or "USB device receives official firmware version
|
||||
update notifications," is set to "Enabled."
|
||||
|
||||
|
||||
BVI mode This configuration item is currently only applicable to the Mac OS
|
||||
(Vision system, and can be recognized and read aloud by Voice over once
|
||||
Impaired enabled. Some configuration items are missing in the vision-impaired
|
||||
Mode) mode compared to the regular mode, so some configuration items may
|
||||
not take effect during device configuration.
|
||||
|
||||
|
||||
💡 NOTE
|
||||
1. Inactive configuration cannot be edited or pushed.
|
||||
2. If you create a new site, the new site will inherit the previous configuration.
|
||||
3. If you delete a site, along with subsites, the configuration is also deleted.
|
||||
|
||||
|
||||
|
||||
|
||||
162 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Personal Device（Task）
|
||||
Task Executing Rules
|
||||
At present, the USB device supports the following task rules.
|
||||
|
||||
Task Execution rules USB devices
|
||||
name
|
||||
|
||||
Update Update the selected devices’ firmware. If √
|
||||
firmware you select the devices of different models,
|
||||
only the firmware applicable to all the
|
||||
devices can be updated.
|
||||
|
||||
Update Update the selected devices’ software. If √
|
||||
software you select the devices of different models,
|
||||
only the software applicable to all the
|
||||
devices can be updated.
|
||||
|
||||
Update Failure
|
||||
The following scenarios may cause the upgrade to fail, please note:
|
||||
1. The upgraded version is too low.
|
||||
2. Official/test versions do not allow mutual updates.
|
||||
3. The current device version is too old and cannot be upgraded.
|
||||
4. The firmware does not match the device.
|
||||
5. Remote update in progress.
|
||||
6. ROM opening failed.
|
||||
7. Device versions for batch updates are inconsistent.
|
||||
8. The OEM ID of the ROM is inconsistent with the current device.
|
||||
9. Under the same branch, a direct update is not possible and a transitional version is
|
||||
required.
|
||||
10. Need to re-plug the device.
|
||||
11. The battery is low.
|
||||
|
||||
|
||||
163 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
12. The ROM file is invalid.
|
||||
13. ROM does not match the device.
|
||||
14. Network anomaly.
|
||||
15. CRC check error.
|
||||
16. Resource conflict or upgrade in progress.
|
||||
17. The device is busy.
|
||||
18. The software is busy.
|
||||
19. Device lost.
|
||||
20. PC software version restrictions.
|
||||
21. The device is being upgraded.
|
||||
|
||||
|
||||
|
||||
Add Task
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Tasks > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select a range and click Next.
|
||||
Task Type: Select Update software or Update firmware.
|
||||
Devices: Select All, Site, or Custom.
|
||||
|
||||
|
||||
|
||||
|
||||
164 / 197
|
||||
@@ -0,0 +1,351 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 521-540
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 521-540 of 953
|
||||
**Chunk:** 27
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the task information.
|
||||
Task Name: Enter the task name.
|
||||
Execution Mode: Select the execution mode as Immediately, or Scheduled Tasks.
|
||||
|
||||
💡 NOTE
|
||||
For Scheduled Tasks, you can set the Execution Time/Start Time/End Time, and you can
|
||||
choose a maximum interval of 2 hours.
|
||||
|
||||
|
||||
Official Version: Select the device model and version.
|
||||
Custom Version: Select the device model and custom firmware version.
|
||||
|
||||
💡 NOTE
|
||||
Uploading a customized version can only be supported when the Task Type is selected to
|
||||
Update firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
165 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Complete. The task will be executed according to your settings.
|
||||
|
||||
💡 NOTE
|
||||
If you add multiple tasks for one device, those tasks are lined up to run in order
|
||||
of their configured execution time.
|
||||
If the device is offline, the task will not be executed.
|
||||
If the task has not expired, it will be executed after the device is restored to an
|
||||
online state.
|
||||
|
||||
|
||||
Failed to Create Task
|
||||
When adding an update task, if there are other update tasks for the YUC/device
|
||||
included in the current task within the selected time period, the addition of the
|
||||
current update task will fail.
|
||||
You can click to download the conflict report to view detailed information, and
|
||||
you can adjust it.
|
||||
|
||||
|
||||
|
||||
|
||||
166 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Task
|
||||
Procedure
|
||||
View the Task List
|
||||
You can view the task type, the task mode, the execution time, and other information.
|
||||
Click View under the Devices/Software tab to see the devices/software/sites that are
|
||||
executing this task.
|
||||
|
||||
|
||||
|
||||
|
||||
167 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View the Execution Details
|
||||
1. In the task list, click Execution Details on the right side of the desired task to view the
|
||||
execution result and the error reason of each executing device.
|
||||
2. In the list, click Retry and confirm the action in the pop-up window. You can make this
|
||||
device to redo the task.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
168 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired task and select Edit.
|
||||
Delete Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
169 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
💡 NOTE
|
||||
The ongoing tasks do not support deletion.
|
||||
|
||||
|
||||
|
||||
|
||||
170 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Personal Device（Statistics）
|
||||
Introduction
|
||||
You can view relevant device data under a site, including total device count,
|
||||
device status at different time points, device model statistics, firmware
|
||||
distribution statistics, device upgrade status, and other data.
|
||||
Go to the Devices Statistics Page
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Statistics.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired site from the drop-down menu. The statistics are given based on the site
|
||||
you select.
|
||||
|
||||
|
||||
|
||||
|
||||
171 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Total Count of Devices and Softwares
|
||||
On the device statistics page, you can view the total number of devices and
|
||||
softwares on the selected site.
|
||||
Clicking the total number of devices will take you to the corresponding device/software list.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Status
|
||||
On the device statistics page, you can view the status statistics based on the
|
||||
selected site within the specified time range.
|
||||
Click
|
||||
|
||||
|
||||
172 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to see the status in day, week, or month view.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select a period and see the status during this period.
|
||||
Hover over to see the number of devices corresponding to each device status at that time
|
||||
point.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Model Statistics
|
||||
On the device statistics page, you can view the model statistics and different
|
||||
model proportions based on the selected site and device type.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
173 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
to select devices models.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to export statistics according to the filter you set.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
174 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
175 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to expand/collapse the device model page.
|
||||
Click the horizontal axis beside the corresponding device model to go to the device
|
||||
management page of that device model.
|
||||
|
||||
|
||||
|
||||
|
||||
176 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Firmware Statistics
|
||||
On the device statistics page, you can view the firmware distribution statistics
|
||||
and proportions based on the selected site.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to select devices models.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
177 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to export statistics according to the filter you set.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
178 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
179 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to expand/collapse the firmware distribution page.
|
||||
Click the horizontal axis beside the corresponding device model to go to the device
|
||||
management page of that device model.
|
||||
|
||||
|
||||
|
||||
|
||||
180 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Upgrade Status
|
||||
On the device statistics page, you can view the device upgrade status based on
|
||||
the selected site.
|
||||
Click to switch and view the upgrade status of the different models.
|
||||
Clicking the number under the Upgradable Devices column will take you to the device
|
||||
management page of that device model.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
181 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to upgrade all non-upgraded devices of the current model to the latest firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
182 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
183 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Personal Device（Firmware）
|
||||
Add Firmware
|
||||
Introduction
|
||||
You can manage the firmware of your device in a unified way. Configure the
|
||||
relevant devices in the enterprise according to the actual situation.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Firmware > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the firmware-related information.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload.
|
||||
Firmware Name: The file name will be automatically filled in as the firmware name after
|
||||
uploading the file. You can also change it manually.
|
||||
Version: After uploading the file, the installation package information will be read, and
|
||||
the version number will be filled in automatically; you can also modify it manually.
|
||||
Supported Model: Select specific product model; multiple selections are available.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to this firmware for future traceability.
|
||||
|
||||
|
||||
184 / 197
|
||||
@@ -0,0 +1,468 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 541-560
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 541-560 of 953
|
||||
**Chunk:** 28
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
185 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Manage Firmware
|
||||
Procedure
|
||||
Go to the Firmware List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Firmware List
|
||||
1. Click the site name on the left side to view the data under this site.
|
||||
2. Check the firmware name, the supported model, and other information in the firmware list.
|
||||
|
||||
|
||||
|
||||
|
||||
186 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Push Firmware
|
||||
For more information, see push the firmware.
|
||||
Copy Firmware Link
|
||||
For more information, see copy the firmware link.
|
||||
Download Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Download to download firmware locally.
|
||||
Edit Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
187 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
Delete Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
188 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
Push Firmware Immediately
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
2. Click Personal Device > Firmware.
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
|
||||
4. In the pop-up window, select Immediately and click Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
189 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
Push Firmware on Scheduled Time
|
||||
Introduction
|
||||
With scheduled tasks, you can choose to push the firmware during the non-
|
||||
working time without affecting the working process.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
2. Click Personal Device > Firmware.
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
|
||||
4. Select Scheduled Tasks in the pop-up window and edit the information
|
||||
|
||||
about the scheduled task. Click to Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
190 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
|
||||
|
||||
Copy Firmware Link
|
||||
Introduction
|
||||
You can copy the firmware download link and share it with others. For security
|
||||
reasons, however, only devices within the enterprise can access this
|
||||
downloading link.
|
||||
Prerequisites
|
||||
Only devices within the enterprise can use this link to download the corresponding files.
|
||||
Direct access to this download link through your browser is not supported.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Personal Device > Firmware.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
191 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired firmware and select Copy Link.
|
||||
|
||||
|
||||
|
||||
|
||||
192 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Monitor Wall
|
||||
Introduction
|
||||
By viewing the monitor wall, you can have a comprehensive and real-time grasp
|
||||
of various data and conditions of the device of each enterprise without the need
|
||||
for frequent manual refreshes.
|
||||
|
||||
Prerequisites
|
||||
Please contact and provide the email of your account to the Yealink Support in order to
|
||||
enable this feature.
|
||||
Only super admin can use this feature, normal users can obtain a link from the super admin
|
||||
and enter the link to view the monitor wall.
|
||||
|
||||
View the Monitor Wall
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Hover the mouse over the thumbnail of the monitor wall and click View.
|
||||
|
||||
|
||||
|
||||
|
||||
4. View various indicators of the device in real time on the monitor wall.
|
||||
|
||||
|
||||
|
||||
|
||||
193 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
N Description
|
||||
u
|
||||
m
|
||||
be
|
||||
r
|
||||
|
||||
1 Current time.
|
||||
|
||||
2 The total number of sites.
|
||||
|
||||
3 Device status. Count the total number of devices and the number and
|
||||
proportion of online/offline/pending devices.
|
||||
|
||||
4 Call Quality Today. Display the total number of calls today and the
|
||||
number of calls of different qualities.
|
||||
|
||||
💡 NOTE
|
||||
Only phone device's monitor wall supports displaying it.
|
||||
|
||||
|
||||
5 Model statistics. Count different types of device and their quantities.
|
||||
|
||||
6 Displays the number of new alarms today.
|
||||
|
||||
7 Active alarm records. Count the largest number of active alarms and
|
||||
|
||||
|
||||
194 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
their detailed information, including: device name, model, site, and last
|
||||
alarm time.
|
||||
|
||||
8 The number of new alarms in the past 7 days. Statistics of the number
|
||||
and severity of daily alarms in the past 7 days.
|
||||
|
||||
9 Top 10 Active Alarm Devices. Count the devices with the highest number
|
||||
of active alarms.
|
||||
|
||||
10 Top 10 Active Alarm Types. Count the 10 largest existing alarm types.
|
||||
|
||||
Set the Monitor Wall
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Settings in the lower right corner of the thumbnail of the monitor wall.
|
||||
|
||||
|
||||
|
||||
|
||||
195 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Data Refresh Period: Set the time for automatic refresh of the monitor wall. It will be
|
||||
updated with real-time data at that frequency.
|
||||
Access Whitelist: If not enabled, devices under any IP can access the monitor wall
|
||||
through links; if enabled, only IP addresses in the whitelist can access.
|
||||
|
||||
|
||||
|
||||
|
||||
Copy the Link of the Monitor Wall
|
||||
You can obtain the link of the monitor wall, which can be accessed by users in
|
||||
the IP whitelist. They can view the specific content of the monitor wall, or
|
||||
display it as material/content on Yealink Digital Signage or Third Party Digital Signage.
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
|
||||
196 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Copy Link in the lower right corner of the thumbnail of the monitor wall.
|
||||
4. Make relevant Settings, click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
197 / 197
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device
|
||||
Configuration
|
||||
Device Config
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
💡 TIP
|
||||
You can refer to Administrator Guide of each device to understand the
|
||||
functions and corresponding configurations of display, audio and video,
|
||||
conference platforms, and network settings.
|
||||
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
1 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If you need to configure a specific device, go to the Device Details page and enter the
|
||||
Configuration Management interface, or click Configure on the right side of the desired
|
||||
device in the device list.
|
||||
If you need to configure devices of the same model in any space, enter Configuration
|
||||
page and then click Configuration on the right side of the device.
|
||||
|
||||
💡 TIP
|
||||
Click View on the Configuration status of each device to check the current config.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click GUI Editor.
|
||||
4. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is offline, it will pick up the updated configuration when it comes
|
||||
back online.
|
||||
The green bubble on the right side of the configuration item displays the number
|
||||
of configurations that have been selected.
|
||||
|
||||
5. Click Save.
|
||||
6. Choose the way to synchronize with Sub-sites.
|
||||
Only synchronize the content of this modification: For the sub-space, only update the
|
||||
modified/added configuration of this time and keep the original content of other
|
||||
configurations.
|
||||
Synchronize all configuration items: For the sub-space, reset them to the current
|
||||
configuration of this level.
|
||||
7. Choose the coverage strategy.
|
||||
Overwrite lower-level area configuration content: Based on the effective scope of the
|
||||
configuration, it will be fully applied to subordinate sites.
|
||||
Do not overwrite the configuration content of the subordinate region: For already
|
||||
configured items at the subordinate level, the parameter values will not be overwritten
|
||||
by this save.
|
||||
8. Click Confirm.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
3 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Prerequisites
|
||||
MVC/TVC/ZVC do not support Text Editor.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
If you need to configure a specific device, go to the Device Details page and enter the
|
||||
Configuration Management interface, or click Configure on the right side of the desired
|
||||
device in the device list.
|
||||
If you need to configure devices of the same model in any space, enter Configuration
|
||||
page and then click Configuration on the right side of the device.
|
||||
|
||||
💡 TIP
|
||||
Click View on the Configuration status of each device to check the current config.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Text Editor.
|
||||
4. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
|
||||
|
||||
5 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Save.
|
||||
6. Choose the way to synchronize with Sub-sites.
|
||||
Only synchronize the content of this modification: For the sub-space, only update the
|
||||
modified/added configuration of this time and keep the original content of other
|
||||
configurations.
|
||||
Synchronize all configuration items: For the sub-space, reset them to the current
|
||||
configuration of this level.
|
||||
7. Select whether to override the strategy.
|
||||
Overwrite lower-level area configuration content: Based on the effective scope of the
|
||||
configuration, it will be fully applied to subordinate sites.
|
||||
Do not overwrite the configuration content of the subordinate region: For already
|
||||
configured items at the subordinate level, the parameter values will not be overwritten
|
||||
by this save.
|
||||
8. Click Confirm.
|
||||
|
||||
For MVC devices, manage Teams configuration
|
||||
Supports setting Teams configuration for MVC series devices.
|
||||
|
||||
💡 NOTE
|
||||
To configure Teams settings using text, please refer to theofficial
|
||||
Microsoft documentation 。
|
||||
|
||||
1. Log in to YMCS.
|
||||
|
||||
6 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Device Management > Device List.
|
||||
3. Click Configuration on the right side of the MVC device.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Configure related content
|
||||
|
||||
Teams
|
||||
Configuration methods support graphical configuration/upload XML file configurations.
|
||||
Graphical configuration mode supports selecting single-screen/dual-screen display.
|
||||
Teams themes support selecting Teams preset themes/custom themes.
|
||||
|
||||
|
||||
|
||||
|
||||
Custom themes need to add wallpapers in Resource Management > Other Resources.
|
||||
|
||||
|
||||
|
||||
|
||||
7 / 171
|
||||
@@ -0,0 +1,491 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 561-580
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 561-580 of 953
|
||||
**Chunk:** 29
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The image size should be exactly 3840 x 1080.
|
||||
|
||||
Click Push, select Immediately or Schedule Task.
|
||||
|
||||
|
||||
|
||||
|
||||
8 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Supports configuration: BIOS, Windows, network settings, Teams
|
||||
configuration, Teams account and password.
|
||||
BIOS, Windows, network settings, Teams configuration, Teams
|
||||
password support batch configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
Software Config
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Workspace > Configuration > Software Config.
|
||||
3. Click Configuration on the right side of the software.
|
||||
|
||||
|
||||
|
||||
|
||||
9 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Manage the configuration according to your needs.
|
||||
5. Click Save and choose the way of synchronizing to Sub-sites. The configuration is created
|
||||
successfully.
|
||||
|
||||
|
||||
|
||||
|
||||
10 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 TIP
|
||||
• Offline and pending devices will take effect after they go online.
|
||||
• Only x.33.95.0 and later versions of YRC support this feature.
|
||||
|
||||
|
||||
|
||||
|
||||
Health Check
|
||||
Introduction
|
||||
Under the traditional operation and maintenance method, the inspection of
|
||||
conference rooms requires manual inspection one by one, which is inefficient.
|
||||
However, through the remote monitoring function of the equipment
|
||||
management platform, the inspection process can be simplified and a report can
|
||||
be generated to help you quickly Understand the health and usage of all your
|
||||
devices.
|
||||
|
||||
Prerequisite
|
||||
The feature is only effective for meeting rooms with a Room Pro license.
|
||||
|
||||
Create Inspection Task
|
||||
Method 1
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace Management > Health Check > Inspection Task > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the inspection task information and click Save.
|
||||
|
||||
11 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Task Name: Name the inspection task.
|
||||
Execution Mode: Select the time and period to execute the task.
|
||||
Range: Select the equipment range for inspection. You can select all devices, devices of
|
||||
any space.
|
||||
Report Type: Select the type of report generated.
|
||||
Summary Report: Only generate one report for the inspection range.
|
||||
Separate Report: Generate a report for each device within the inspection range.
|
||||
Recipient: Select the administrator as the notification target of the inspection results, and
|
||||
the administrator will be notified via email.
|
||||
|
||||
|
||||
|
||||
|
||||
Method 2
|
||||
|
||||
💡 NOTE
|
||||
For a single meeting room.
|
||||
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace Management > Rooms > Health Check > Check.
|
||||
|
||||
|
||||
|
||||
|
||||
12 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Detail to view the Inspection task record.
|
||||
|
||||
Manage Inspection Task
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace Management > Inspection > Inspection Task.
|
||||
3. All inspection tasks you created will be displayed in the list.
|
||||
|
||||
View inspection tasks
|
||||
1. In the inspection task list, check the task status, execution mode, execution time, and other
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Inspection Task
|
||||
|
||||
💡 NOTE
|
||||
|
||||
13 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
You can only edit paused tasks.
|
||||
|
||||
1. In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit on the right side of the task.
|
||||
|
||||
Pause/Continue/End Inspection Task
|
||||
In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
14 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Pause / End on the right side of the active periodic task, pause/end the task.
|
||||
In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Continue on the right side of the paused task, continue the task.
|
||||
|
||||
|
||||
|
||||
15 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Delete Task
|
||||
|
||||
💡 NOTE
|
||||
Only finished tasks can be deleted.
|
||||
|
||||
1. In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the task.
|
||||
|
||||
|
||||
|
||||
Execution Record
|
||||
Introduction
|
||||
For the finished inspection task, you can view its corresponding execution
|
||||
record to learn whether the task was successfully executed, the reason for the
|
||||
execution failure, the execution time, and other information.
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Do one of the following to enter the execution record:
|
||||
Click Workspace Management > Inspection > Inspection Task, and click Record on the
|
||||
|
||||
16 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
right side of any task.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Workspace Management > Execution Record.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Check the task execution record. Under the execution result field, you can check whether
|
||||
the task is executed normally and whether there are any exceptions in the inspection
|
||||
results. For tasks that perform abnormally or fail, you can check the specific reasons.
|
||||
|
||||
|
||||
|
||||
View Report
|
||||
Introduction
|
||||
Based on the inspection tasks you create, corresponding reports will be
|
||||
generated to help you understand the health status and usage of the device.
|
||||
|
||||
17 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
The inspection content included in the report is as follows:
|
||||
|
||||
Inspectio Description Exception handling Supported
|
||||
n content suggestions device models
|
||||
|
||||
Device Check the online If the host device is All room devices
|
||||
Status status of the host offline, it is abnormal.
|
||||
device. It is recommended to
|
||||
check whether the
|
||||
device network
|
||||
connection is available
|
||||
and whether the device
|
||||
management service is
|
||||
disabled.
|
||||
|
||||
Alarms Check whether If there are active All room devices
|
||||
there are active alarms on the host
|
||||
alarms on the device, it is abnormal.
|
||||
device. It is recommended to
|
||||
check the
|
||||
corresponding alarm
|
||||
records and handle
|
||||
them according to the
|
||||
suggestions.
|
||||
|
||||
Peripheral Check the If there are offline All room devices
|
||||
Status information of accessories, it is
|
||||
each accessory abnormal. It is
|
||||
connected to the recommended to
|
||||
host device, check whether the
|
||||
including: model, accessory connection
|
||||
firmware version, is normal.
|
||||
and online status.
|
||||
18 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
CPU Check the CPU If the CPU usage of the Android
|
||||
Usage usage of the host host device has conference
|
||||
device in the past reached 90%, it is room device
|
||||
24 hours. abnormal. Please
|
||||
check and stop
|
||||
unnecessary running
|
||||
tasks.
|
||||
|
||||
Memory Check the If the memory usage of Android
|
||||
memory usage of the host device has conference
|
||||
the host device in reached 90%, it is room device
|
||||
the past 24 hours. abnormal. Please
|
||||
check and stop
|
||||
unnecessary running
|
||||
tasks.
|
||||
|
||||
Storage Check the If the remaining Android
|
||||
Space remaining storage storage space of the conference
|
||||
space of the host host device is less than room device
|
||||
device. 500MB, it is abnormal.
|
||||
Please clean up the
|
||||
useless files stored on
|
||||
the device in time, or
|
||||
try to restore factory
|
||||
settings if necessary.
|
||||
|
||||
Related Check whether If an updated version is All room devices
|
||||
Device the device detected, it is
|
||||
Firmware firmware version abnormal and it is
|
||||
needs to be recommended to
|
||||
updated. upgrade the device to
|
||||
the latest version.
|
||||
|
||||
19 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Do one of the following to enter the execution record:
|
||||
|
||||
💡 NOTE
|
||||
Viewing reports is not supported on devices that failed to execute.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Workspace Management > Inspection > Inspection Task, click Record > View on
|
||||
the right of the completed task.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Workspace Management > Inspection > Execution Record, and click View on the
|
||||
right side of any record.
|
||||
3. View various inspection results in the report. Support clicking Download to download the
|
||||
|
||||
|
||||
20 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
report locally.
|
||||
|
||||
|
||||
|
||||
|
||||
Scheduled Task
|
||||
Add Scheduled Task
|
||||
|
||||
💡 NOTE
|
||||
USB Management is newly upgraded for Personal Devices. For more
|
||||
information about adding tasks of USB devices, see Ass USB Device Tasks.
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Tasks > Scheduled Tasks.
|
||||
3. Click Add.
|
||||
4. Select a range and click Next.
|
||||
Device Type: Select Phone Device, Room Device, or USB Device.
|
||||
Devices: Select All, Site, Group,or Custom.
|
||||
|
||||
|
||||
|
||||
|
||||
21 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit the task information.
|
||||
Task Name: Enter the task name.
|
||||
Execution Mode: Select the execution mode as Immediately, One-time Task, Daily,
|
||||
Every Week, or Every Month.
|
||||
|
||||
|
||||
|
||||
|
||||
Task modes Description
|
||||
|
||||
Instant task The task will be executed immediately.
|
||||
|
||||
One-time The task will be executed once at the scheduled time you set.
|
||||
task
|
||||
|
||||
Recurring The task will be executed periodically at the scheduled time
|
||||
task you set (daily/weekly/monthly).
|
||||
|
||||
22 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Task: Select the task type.
|
||||
|
||||
Task Name Execution Rule Does Conference
|
||||
Room Equipment
|
||||
Support
|
||||
|
||||
Reboot Restart the selected device. √
|
||||
|
||||
Reset to Restore factory settings for the selected √
|
||||
Factory device.
|
||||
|
||||
Config Back up all device configuration files to √
|
||||
Backup avoid situations where configuration
|
||||
files cannot be recovered due to
|
||||
damage.
|
||||
|
||||
Update Push resource files to the selected √
|
||||
Resource device. The same type of resource only
|
||||
Files allows one selection for transmission,
|
||||
sending global parameters to the
|
||||
selected device.
|
||||
|
||||
Update Update firmware for the selected √
|
||||
Firmware device. If multiple different types of
|
||||
devices are selected, the firmware
|
||||
supported by different types of devices
|
||||
will be retrieved.
|
||||
|
||||
Reset The display will be reset to the device's √
|
||||
Screen built-in default display parameters.
|
||||
|
||||
1. Click Complete. The task will be executed according to your settings.
|
||||
|
||||
💡 NOTE
|
||||
If you add multiple tasks for one device, those tasks are lined up to run in order
|
||||
of their configured execution time.
|
||||
If the device is offline, the task will not be executed.
|
||||
|
||||
|
||||
23 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
If the task has not expired, it will be executed after the device is restored to an
|
||||
online state.
|
||||
|
||||
|
||||
Manage Scheduled Tasks
|
||||
|
||||
💡 NOTE
|
||||
USB Management is newly upgraded for Personal Devices. For more
|
||||
information about managing USB device tasks, see Manage USB Device
|
||||
Tasks.
|
||||
|
||||
|
||||
Access the Scheduled Task List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Tasks > Scheduled Tasks.
|
||||
|
||||
View the Scheduled Task List
|
||||
You can view the task type, the execution status, the execution mode, and other
|
||||
information.
|
||||
Click View under the Devices tab to see which devices are executing this task and their
|
||||
device types.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Execution Record
|
||||
1. In the scheduled task list, click Execution Record on the right side of the desired task.
|
||||
2. The record includes the execution time and the execution status.
|
||||
3. (Optional) Click Execution Details to view the execution result and the error reason of each
|
||||
|
||||
|
||||
24 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
executing device.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
25 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired pending or paused task and select Edit.
|
||||
|
||||
Pause Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the recurring task and select Pause.
|
||||
|
||||
Resume Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
27 / 171
|
||||
@@ -0,0 +1,385 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 581-600
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 581-600 of 953
|
||||
**Chunk:** 30
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired paused task and select Continue. If the task has not
|
||||
expired, the task will be executed and completed on the time you set.
|
||||
|
||||
End Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> End.
|
||||
|
||||
💡 NOTE
|
||||
If you terminate an executing scheduled task, the task will continue to be
|
||||
executed until it completes. However, if you terminate a one-time or
|
||||
recurring task, it will no longer be executed.
|
||||
|
||||
Delete Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
Resources
|
||||
Firmware
|
||||
Add Firmware
|
||||
You can manage the firmware of your device in a unified way. Configure the
|
||||
relevant devices in the enterprise according to the actual situation.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
30 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Device > Resources > Firmware > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit firmware-related information.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload.
|
||||
Firmware Name: The file name will be automatically filled in as the firmware name after
|
||||
uploading the file. You can also change it manually.
|
||||
Version: After uploading the file, the installation package information will be read, and the
|
||||
version number will be filled in automatically; you can also modify it manually.
|
||||
Supported Model: Select specific product model; multiple selections are available.
|
||||
Area: Select the area.
|
||||
Description: You can enter a description specific to this firmware for future traceability.
|
||||
1. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Firmware
|
||||
31 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
Go to the Firmware List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Resources > Firmware .
|
||||
|
||||
|
||||
|
||||
|
||||
View the Firmware List
|
||||
1. Click the area name on the left side to view the data under this area.
|
||||
2. Check the firmware name, version number, and other information in the firmware list.
|
||||
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Resources > Firmware .
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
|
||||
32 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
4. In the pop-up window, select Immediately or Scheduled Task
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Select Device and Save.
|
||||
6. Complete pushing. You can check the execution status in the Task Management
|
||||
|
||||
Copy Firmware Link
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
33 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> copy link
|
||||
|
||||
|
||||
|
||||
|
||||
Download Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
34 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Download to download firmware locally.
|
||||
|
||||
Edit Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
35 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
|
||||
Delete Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
36 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
Others
|
||||
Add Resources
|
||||
You can add many types of files (e.g., wallpapers, ringtones, etc.) as resource
|
||||
files and assign them to the relevant devices in your enterprise, depending on
|
||||
the actual situation.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Resources > Others > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
37 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit resource-related information.
|
||||
Resource Type : Select the resource type. For more information, see the resource type
|
||||
description.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload. The file type
|
||||
should be the same as the resource type you selected in the previous option.
|
||||
Resource Name: The file name will be automatically filled in as the resource name after
|
||||
uploading the file; you can also change it manually.
|
||||
Area: Select the area.
|
||||
Description: You can enter a description specific to the resource for future traceability.
|
||||
4. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
38 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Resources
|
||||
39 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
Go to the Resource List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Resources > Others .
|
||||
|
||||
|
||||
|
||||
|
||||
View the Resource List
|
||||
1. Click the area name on the left side to view the data under this area.
|
||||
2. Check the resource name, the version number, and other information in the resource list.
|
||||
|
||||
Push Resource
|
||||
1. Click Push on the right side of the desired resource.
|
||||
2. In the pop-up window, select Immediatelyor Scheduled Task and click Select Device .
|
||||
|
||||
|
||||
|
||||
|
||||
40 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select the desired device and click Save.
|
||||
4. Complete pushing.
|
||||
|
||||
Copy Resource Link
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Resources > Others.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and select Copy Link .
|
||||
|
||||
|
||||
|
||||
|
||||
Download Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
42 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Download.
|
||||
|
||||
Edit Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
43 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Edit.
|
||||
|
||||
Delete Resource
|
||||
1. In the resource list, click
|
||||
|
||||
|
||||
|
||||
|
||||
44 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired resource and click Delete.
|
||||
|
||||
Introduction on Resource Type
|
||||
|
||||
Resource type Description Supported file File size
|
||||
names types limit
|
||||
|
||||
SkypeSettings Skype configuration .xml/ .zip 50M
|
||||
|
||||
DST Template Daylight Saving .xml 2M
|
||||
Time template
|
||||
|
||||
Language Packet Language packages .lang 2M
|
||||
|
||||
Input Method Input methods .txt 2M
|
||||
|
||||
Lync Device Device licenses .dat/ .zip 50M
|
||||
License
|
||||
|
||||
Local Directory XML contacts .xml 2M
|
||||
|
||||
45 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
File(XML)
|
||||
|
||||
Local Directory CSV contacts .csv 2M
|
||||
File(CSV)
|
||||
|
||||
Wallpaper Wallpapers .png/ .jpg/ .bmp 5M
|
||||
|
||||
Screensaver Screensavers .png/ .jpg/ .bmp 5M
|
||||
|
||||
Logo Logos .png/ .jpg/ .bmp 2M
|
||||
|
||||
Web Item Level Three levels of .cfg 2M
|
||||
Template authority
|
||||
|
||||
Trusted Trusted certificates .pem/ .cer/ .crt/ .d 5M
|
||||
Certificates er
|
||||
|
||||
Server Server certificates .pem/ .cer 5M
|
||||
Certificates
|
||||
|
||||
Proxy Auto- Auto configure .pac 2M
|
||||
config proxy
|
||||
|
||||
|
||||
|
||||
|
||||
46 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Dashboard
|
||||
Simple Mode
|
||||
In Simple Mode, you can view the total number of meeting rooms, meeting
|
||||
room occupancy rate, number of problematic meeting rooms, total number of
|
||||
devices, device online rate, total number of alerts and feedback, as well as the
|
||||
number of new additions today.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Scroll down in Simple Mode to switch to Professional Mode.
|
||||
|
||||
Professional Mode
|
||||
Various data, such as the total number of meeting rooms, the total number of
|
||||
problem rooms, the total number of devices, and the total number of offline
|
||||
devices, will be visualized in the dashboard. The dashboard allows you to
|
||||
visually monitor the status of each meeting room in your organization and
|
||||
manage devices based on the meeting room dimension.
|
||||
The room dashboard displays the following:
|
||||
|
||||
|
||||
|
||||
|
||||
47 / 171
|
||||
@@ -0,0 +1,423 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 601-620
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 601-620 of 953
|
||||
**Chunk:** 31
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
No Description
|
||||
.
|
||||
|
||||
1 The navigation menu.
|
||||
|
||||
2 Total number of rooms .
|
||||
|
||||
3 Total number of problematic meeting rooms.
|
||||
|
||||
4 Total number of devices.
|
||||
|
||||
5 Total number of offline devices.
|
||||
|
||||
6 The status ratio and number of meeting rooms; click the graph to jump
|
||||
to the corresponding list of meeting rooms.
|
||||
|
||||
7 The status ratio and number of devices; click the graph to jump to the
|
||||
corresponding list of devices.
|
||||
|
||||
8 The alarms related to meeting rooms and the number of processed and
|
||||
unprocessed alarms.
|
||||
|
||||
9 AI assistant diagnoses device issues
|
||||
|
||||
10 Recent tasks and inspection tasks for the past 7 days.
|
||||
|
||||
11 Model statistics; click the graph to jump to the corresponding list of
|
||||
devices.
|
||||
|
||||
|
||||
48 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
AI Assistant
|
||||
Introduction
|
||||
You can describe your issues in a conversational manner or retrieve information
|
||||
related to devices, alarms, tasks, configuration statements, etc. The AI assistant
|
||||
will recognize your command intentions and help you quickly solve problems.
|
||||
|
||||
Prerequisites
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
49 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
to agree to the privacy agreement to start using. You can disable it on the
|
||||
enterprise side.
|
||||
AI Assistant Retrieval
|
||||
1. Log in to YMCS.
|
||||
2. On the Workspace Management interface, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the bottom right corner of the interface.
|
||||
|
||||
|
||||
|
||||
|
||||
50 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Describe your problem in the input box and send it. The AI assistant will provide you with
|
||||
the corresponding solution.
|
||||
4. Instructions, query conditions, and examples, please refer to: Instructions, Query
|
||||
conditions, and Examples
|
||||
|
||||
💡 TIP
|
||||
It is recommended that your description follow the format below to help the
|
||||
AI assistant analyze better:
|
||||
Help me [query] [online device]
|
||||
Help me [reboot] [online device] [at 12 A.M. every day]
|
||||
Help me [update configuration], [model name is RoomCast], [configure the
|
||||
time format to be 24 hour]
|
||||
To better tailor the AI assistant to your usage habits, you can perform any of
|
||||
the following actions on the AI assistant:
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
51 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
52 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to change the floating method of the AI assistant.
|
||||
Click Shortcut Command to quickly invoke the configuration tool.
|
||||
Click New Chat to start a new conversation and ask the AI assistant
|
||||
questions; click History dialogue to find previous search records.
|
||||
|
||||
|
||||
|
||||
|
||||
53 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Shortcut Command
|
||||
1. Log in to YMCS.
|
||||
|
||||
|
||||
|
||||
54 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. On the Workspace Management interface, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the bottom right corner of the interface.
|
||||
AI Diagnosis
|
||||
1. Click shortcut command > AI Diagnosis
|
||||
|
||||
|
||||
|
||||
|
||||
55 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Describe the problem you encounter.
|
||||
|
||||
|
||||
|
||||
|
||||
56 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Configuration Tool
|
||||
1. Click the Shortcut command > Configuration Tool
|
||||
|
||||
|
||||
|
||||
|
||||
57 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. According to your needs, select Explain/Generate M7 Statements or Configure Push
|
||||
Configurations
|
||||
|
||||
|
||||
|
||||
|
||||
58 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Active Alarms Summary
|
||||
1. Click the Shortcut command > Active Alarms Summary
|
||||
2. Select area.
|
||||
|
||||
|
||||
|
||||
|
||||
59 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Retrieve Configuration Statement
|
||||
|
||||
💡 TIP
|
||||
In the AI assistant settings page, after enabling quick search and
|
||||
|
||||
|
||||
60 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
configuration tools, you can use the following quick search and
|
||||
configuration tool functions.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Log in to YMCS.
|
||||
2. When configuring text parameters for phone devices, conference devices, and personal
|
||||
devices, perform one of the following operations:
|
||||
Click Configuration Generation, input the function for which you want to generate
|
||||
configuration statements, such as enabling hotspot, and press Enter to send.
|
||||
|
||||
|
||||
|
||||
|
||||
61 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Left-click and select the configuration statement text, click Explain, and the AI assistant will
|
||||
provide relevant explanations for that statement.
|
||||
|
||||
|
||||
|
||||
|
||||
62 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
AI Analysis
|
||||
1. Log in to YMCS.
|
||||
2. Start Diagnosing.
|
||||
3. After the diagnostics are complete, click AI Analysis.
|
||||
4. Enter the problem you are facing in the input box, such as: the speaker tracking feature of
|
||||
the device is not working, and press Enter.
|
||||
5. The AI assistant will troubleshoot for you and provide the corresponding solution.
|
||||
|
||||
|
||||
|
||||
|
||||
AI Search
|
||||
You can use AI search to retrieve device models, MAC addresses, etc., for quick
|
||||
search results.
|
||||
|
||||
|
||||
|
||||
|
||||
63 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Instructions, Query conditions, and
|
||||
Examples
|
||||
💡 NOTE
|
||||
Sub-admins can only use Knowledge Q&A and M7 configuration queries.
|
||||
|
||||
|
||||
Knowledge Q&A
|
||||
No parameters
|
||||
Examples
|
||||
How to configure the IP address on T54W?
|
||||
Introduce MCore parameters
|
||||
What is YMCS?
|
||||
Which headset supports ANC?
|
||||
Is MVC860 compatible with Cisco?
|
||||
How to delete a device?
|
||||
|
||||
Room Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Location Name /
|
||||
|
||||
64 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Room Name /
|
||||
|
||||
License status All
|
||||
Unassigned
|
||||
Assigned
|
||||
Expired
|
||||
|
||||
Examples
|
||||
Query room with room name is test
|
||||
Query room with status assigned
|
||||
Query all rooms
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins can only use Knowledge Q&A and M7 configuration queries; they cannot execute
|
||||
room queries.
|
||||
|
||||
|
||||
Task Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Task Name /
|
||||
|
||||
Task Content Reboot
|
||||
Reset
|
||||
Send Message
|
||||
Push Resource …
|
||||
|
||||
Task Execution Status Active
|
||||
Paused
|
||||
Finished
|
||||
|
||||
Task Execution Cycle Immediately
|
||||
One-time Task /Scheduled Task
|
||||
Periodic Task (Daily)
|
||||
Periodic Task (Every Week)
|
||||
Periodic Task (Every Month)
|
||||
|
||||
65 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Examples
|
||||
Query the tasks with task execution method of daily.
|
||||
Query the tasks with a status of Active.
|
||||
Query the tasks named reboot.
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing task queries.
|
||||
|
||||
|
||||
Inspection Task Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Task Name /
|
||||
|
||||
Task Execution Cycle Immediately
|
||||
One-time Task\Scheduled Task
|
||||
Periodic Task (Daily)
|
||||
Periodic Task (Every Week)
|
||||
Periodic Task (Every Month)
|
||||
|
||||
Task report type Separate Report
|
||||
Summary Report
|
||||
|
||||
Task status Active
|
||||
Paused
|
||||
Finished
|
||||
|
||||
Examples
|
||||
Query inspection tasks containing phone in task name
|
||||
Query active inspection tasks
|
||||
Query inspection tasks with daily execution cycle
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing task execution record queries.
|
||||
|
||||
|
||||
|
||||
66 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Task Execution Record Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Task Name /
|
||||
|
||||
Task Execution Cycle Immediately
|
||||
One-time Task/Scheduled Task
|
||||
Periodic Task (Daily)
|
||||
Periodic Task (Every Week)
|
||||
Periodic Task (Every Month)
|
||||
|
||||
Task Content Reboot
|
||||
Reset
|
||||
Send Message
|
||||
Push Resource …
|
||||
|
||||
Task Execution Cycle Executing
|
||||
Success
|
||||
Failure
|
||||
Partial failure
|
||||
|
||||
Examples
|
||||
Query the task records named reboot
|
||||
Query the task records which execution cycle is daily
|
||||
Query the tasks records that content is reboot
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing task execution record queries.
|
||||
|
||||
|
||||
Inspection Task Execution Record Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Task Name /
|
||||
|
||||
|
||||
67 / 171
|
||||
@@ -0,0 +1,565 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 621-640
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 621-640 of 953
|
||||
**Chunk:** 32
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Task report Type Separate Report
|
||||
Summary Report
|
||||
|
||||
Execution result Executing
|
||||
Normal
|
||||
All Abnormal
|
||||
Partial Abnorma
|
||||
l Execute Failure
|
||||
|
||||
Examples
|
||||
Query the inspection task records named reboot
|
||||
Query the inspection task records which report Type is Separate Report
|
||||
Query the inspection tasks records that Execution result is Executing
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing inspection task execution record queries.
|
||||
|
||||
|
||||
Alarm Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Location Name /
|
||||
|
||||
Room Name /
|
||||
|
||||
Alarm severity level Common Primary Critical
|
||||
|
||||
Alarm content or event Device offline
|
||||
Peripheral offline
|
||||
Firmware update failure
|
||||
Configuration update failure
|
||||
Peripheral firmware update failure
|
||||
Wireless mic low power
|
||||
Sensor low power
|
||||
Sensor upgrade failure
|
||||
|
||||
68 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Network disconnection
|
||||
|
||||
Range of last alarm time /
|
||||
|
||||
Examples:
|
||||
Query alarm with content is device offline
|
||||
Query alarm with content is device offline and room name is test
|
||||
Query alarm with severity level is common or primary
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing alarm queries.
|
||||
|
||||
|
||||
Active/Resolved Alarm Feedback Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
Location Name /
|
||||
|
||||
feedback content /
|
||||
|
||||
Urgency level High Medium
|
||||
Low
|
||||
|
||||
Progress status, only active feedback support this filed Unprocessed
|
||||
Processing
|
||||
|
||||
Examples:
|
||||
Query active alarm feedback with high urgency
|
||||
Query resolved alarm feedback with status unprocessed
|
||||
Query all active alarm feedback
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing alarm feedback queries.
|
||||
|
||||
|
||||
Alarm Summary
|
||||
|
||||
|
||||
69 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Description Value Range
|
||||
|
||||
Location Name /
|
||||
|
||||
Examples:
|
||||
Perform alarm summary in the region test
|
||||
Summarize all alarms in test
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing alarm summaries.
|
||||
|
||||
|
||||
M7 Query and Generation
|
||||
M7 statements are used for device configuration in the format of Key=Value, e.g.,
|
||||
screensaver.timeout=30, lang.gui=English
|
||||
|
||||
Description Value Range
|
||||
|
||||
Device Model /
|
||||
|
||||
Examples:
|
||||
Generate config, open screensaver, model is MeetingBoard 65
|
||||
Query m7, screensaver.enable=1, model is MeetingBoard 65
|
||||
Generate config, open screensaver and set wait time to 60, model is
|
||||
Meetingboard 65
|
||||
|
||||
💡 NOTE
|
||||
This command requires specifying the device model to execute, such as MeetingBoard 65 or
|
||||
SIP-T54W.
|
||||
|
||||
|
||||
Device Query/Associated Device Query
|
||||
|
||||
Description Value Range
|
||||
|
||||
MAC address usually 12 hexadecimal numbers, format may be
|
||||
01:23:45:67:89:AB; may also be af0001000817
|
||||
|
||||
Device status Pending
|
||||
|
||||
70 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Offline
|
||||
Online
|
||||
|
||||
Device name /
|
||||
|
||||
Unique SN code /
|
||||
of the device
|
||||
|
||||
Device model /
|
||||
|
||||
Public IP /
|
||||
address
|
||||
|
||||
Private IP /
|
||||
address
|
||||
|
||||
Device firmware /
|
||||
version
|
||||
|
||||
Active status Active
|
||||
Inactive
|
||||
|
||||
Software /
|
||||
|
||||
Software version /
|
||||
|
||||
Assign status Assign
|
||||
Unassigned
|
||||
|
||||
Examples:
|
||||
Query devices with offline status
|
||||
Query devices with firmware version 328.32.255.0
|
||||
Query devices with IP address 172.32.255.255
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing device queries or associated device queries.
|
||||
|
||||
|
||||
Reboot, Reset
|
||||
|
||||
71 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Descript Value Range
|
||||
ion
|
||||
|
||||
Execution Immediate, One-time task, Daily, Every Week, Every Month
|
||||
cycle
|
||||
|
||||
Execution /
|
||||
time
|
||||
|
||||
Days of /
|
||||
executio
|
||||
n
|
||||
|
||||
Device The query conditions are same with query device, and batch
|
||||
informat device execution is supported, but the scope of device execution
|
||||
ion must be clearly defined, such as device status, MAC address, etc.
|
||||
|
||||
Examples:
|
||||
Restart online devices
|
||||
Restart online devices at 4:00 AM on the 1st of every month
|
||||
Restart online devices at 12:00 PM every Wednesday and Thursday
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing restart, reset. If the execution time of a task is not specified, it will
|
||||
default to immediate execution.
|
||||
|
||||
|
||||
Device Diagnosis
|
||||
|
||||
Desc Value Range
|
||||
ripti
|
||||
on
|
||||
|
||||
Diagn One click export
|
||||
ostic Packet capture
|
||||
tool Export system log
|
||||
|
||||
|
||||
72 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Export configuration file
|
||||
Configuration backup
|
||||
Network detection
|
||||
Screen capture
|
||||
Remote control
|
||||
Health check
|
||||
|
||||
Devic The query conditions are same with query device, and batch device
|
||||
e execution is supported, but the scope of device execution must be
|
||||
infor clearly defined, such as device status, MAC address, etc.
|
||||
mati
|
||||
on
|
||||
|
||||
Examples:
|
||||
Export system logs for device with IP address 192.168.1.1
|
||||
Perform packet capture for device with MAC af0021017800
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support device diagnostics.
|
||||
|
||||
|
||||
Update Configuration
|
||||
|
||||
Des Value Range
|
||||
cri
|
||||
pti
|
||||
on
|
||||
|
||||
Con Requires device configuration modification, can be M7 statements, in
|
||||
fig the format of Key=Value, e.g., screensaver.timeout,
|
||||
ura screensaver.timeout=30, lang.gui; or configuration function
|
||||
tio description, e.g., enable screensaver, screensaver wait time 20s
|
||||
n
|
||||
|
||||
|
||||
73 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Dev parameters same as device query, only support single device
|
||||
ice configuration modification or same model device configuration
|
||||
inf modification
|
||||
orm
|
||||
ati
|
||||
on
|
||||
|
||||
Update device config, switch tracking mode to auto frame for MAC
|
||||
af0021017800
|
||||
Update configuration with screensaver.enable=1 for model MeetingBoard 65
|
||||
|
||||
💡 NOTE
|
||||
Sub-admins are only supported for Knowledge Q&A and M7 configuration queries; they do
|
||||
not support executing configuration updates.
|
||||
|
||||
|
||||
Only for redirection
|
||||
The following features only support intention recognition, do not support
|
||||
parameter extraction, and will redirect to corresponding function page after
|
||||
intention recognition
|
||||
Add conference room
|
||||
Update firmware
|
||||
Add device
|
||||
Query or modify alarm notifications or alarm rules
|
||||
Enterprise Information Query
|
||||
|
||||
|
||||
|
||||
|
||||
74 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
75 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Hierarchy
|
||||
Introduction
|
||||
You can build the workspace by adding/editing/deleting hierarchical structures
|
||||
(country, state/province, city, park, building) according to the actual situation of
|
||||
the enterprise.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
76 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
on the right side of the hierarchy to add/edit/delete the hierarchy.
|
||||
|
||||
|
||||
|
||||
|
||||
77 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Inspection
|
||||
Inspection Task
|
||||
Introduction
|
||||
Under the traditional operation and maintenance method, the inspection of
|
||||
conference rooms requires manual inspection one by one, which is inefficient.
|
||||
However, through the remote monitoring function of the equipment
|
||||
management platform, the inspection process can be simplified and a report can
|
||||
be generated to help you quickly Understand the health and usage of all your
|
||||
devices.
|
||||
|
||||
Create Inspection Task
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace Management > Inspection > Inspection Task > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the inspection task information and click Save.
|
||||
Task Name: Name the inspection task.
|
||||
Execution Mode: Select the time and period to execute the task.
|
||||
Range: Select the equipment range for inspection. You can select all devices, devices of
|
||||
any space, or customize any devices.
|
||||
Report Type: Select the type of report generated.
|
||||
|
||||
78 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Summary Report: Only generate one report for the inspection range.
|
||||
Separate Report: Generate a report for each device within the inspection range.
|
||||
Recipient: Select the administrator as the notification target of the inspection results, and
|
||||
the administrator will be notified via email.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Inspection Task
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace Management > Inspection > Inspection Task.
|
||||
3. All inspection tasks you created will be displayed in the list.
|
||||
View inspection tasks
|
||||
1. In the inspection task list, check the task status, execution mode, execution time, and other
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
79 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Edit Inspection Task
|
||||
💡 NOTE
|
||||
You can only edit paused tasks.
|
||||
|
||||
1. In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit on the right side of the task.
|
||||
Pause/Continue/End Inspection Task
|
||||
In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
80 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Pause / End on the right side of the active periodic task, pause/end the task.
|
||||
In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Continue on the right side of the paused task, continue the task.
|
||||
Delete Task
|
||||
81 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
Only finished tasks can be deleted.
|
||||
|
||||
1. In the inspection task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right side of the task.
|
||||
|
||||
|
||||
|
||||
Execution Record
|
||||
Introduction
|
||||
For the finished inspection task, you can view its corresponding execution
|
||||
record to learn whether the task was successfully executed, the reason for the
|
||||
execution failure, the execution time, and other information.
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Do one of the following to enter the execution record:
|
||||
Click Workspace Management > Inspection > Inspection Task, and click Record on the
|
||||
right side of any task.
|
||||
|
||||
|
||||
|
||||
82 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Workspace Management > Execution Record.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Check the task execution record. Under the execution result field, you can check whether
|
||||
the task is executed normally and whether there are any exceptions in the inspection
|
||||
results. For tasks that perform abnormally or fail, you can check the specific reasons.
|
||||
|
||||
|
||||
|
||||
View Report
|
||||
Introduction
|
||||
Based on the inspection tasks you create, corresponding reports will be
|
||||
generated to help you understand the health status and usage of the device.
|
||||
The inspection content included in the report is as follows:
|
||||
|
||||
83 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Inspec Description Exception handling Supported
|
||||
tion suggestions device
|
||||
conten models
|
||||
t
|
||||
|
||||
Device Check the If the host device is offline, it All room
|
||||
Status online status of is abnormal. It is devices
|
||||
the host device. recommended to check
|
||||
whether the device network
|
||||
connection is available and
|
||||
whether the device
|
||||
management service is
|
||||
disabled.
|
||||
|
||||
Alarms Check whether If there are active alarms on All room
|
||||
there are active the host device, it is devices
|
||||
alarms on the abnormal. It is recommended
|
||||
device. to check the corresponding
|
||||
alarm records and handle
|
||||
them according to the
|
||||
suggestions.
|
||||
|
||||
Periphe Check the If there are offline All room
|
||||
ral information of accessories, it is abnormal. It devices
|
||||
Status each accessory is recommended to check
|
||||
connected to whether the accessory
|
||||
the host device, connection is normal.
|
||||
including:
|
||||
model, firmware
|
||||
version, and
|
||||
online status.
|
||||
|
||||
CPU Check the CPU If the CPU usage of the host Android
|
||||
|
||||
84 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Usage usage of the device has reached 90%, it is conference
|
||||
host device in abnormal. Please check and room device
|
||||
the past 24 stop unnecessary running
|
||||
hours. tasks.
|
||||
|
||||
Memor Check the If the memory usage of the Android
|
||||
y memory usage host device has reached 90%, conference
|
||||
of the host it is abnormal. Please check room device
|
||||
device in the and stop unnecessary
|
||||
past 24 hours. running tasks.
|
||||
|
||||
Storage Check the If the remaining storage space Android
|
||||
Space remaining of the host device is less than conference
|
||||
storage space of 500MB, it is abnormal. Please room device
|
||||
the host device. clean up the useless files
|
||||
stored on the device in time,
|
||||
or try to restore factory
|
||||
settings if necessary.
|
||||
|
||||
Related Check whether If an updated version is All room
|
||||
Device the device detected, it is abnormal and it devices
|
||||
Firmwa firmware is recommended to upgrade
|
||||
re version needs to the device to the latest
|
||||
be updated. version.
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Do one of the following to enter the execution record:
|
||||
|
||||
💡 NOTE
|
||||
Viewing reports is not supported on devices that failed to execute.
|
||||
|
||||
|
||||
|
||||
|
||||
85 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Workspace Management > Inspection > Inspection Task, click Record > View on
|
||||
the right of the completed task.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Workspace Management > Inspection > Execution Record, and click View on the
|
||||
right side of any record.
|
||||
3. View various inspection results in the report. Support clicking Download to download the
|
||||
report locally.
|
||||
|
||||
|
||||
|
||||
|
||||
86 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
87 / 171
|
||||
@@ -0,0 +1,433 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 641-660
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 641-660 of 953
|
||||
**Chunk:** 33
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Room Management
|
||||
Add Rooms
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms > Rooms > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the name, the location, the capacity, and the description of the room according to the
|
||||
actual situation of the room in the enterprise.
|
||||
4. Click Save, and the room is created, or click Save and Add Another and repeat the above
|
||||
operation to continue creating rooms.
|
||||
|
||||
Import Rooms
|
||||
Introduction
|
||||
If you want to quickly add multiple rooms or modify room information in batch,
|
||||
you can import rooms in batch. You need to download the template, add
|
||||
multiple rooms or export rooms, edit the room information, and then import
|
||||
the file into YMCS.
|
||||
|
||||
Procedure
|
||||
88 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace> Rooms > Rooms > Import.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Download Template. Edit the device information according to the guidance in the
|
||||
template.
|
||||
4. Save the file and upload it.
|
||||
5. Click Upload.
|
||||
|
||||
|
||||
|
||||
|
||||
89 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Manage Rooms
|
||||
View the Room List
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms > Rooms.
|
||||
3. View the meeting room list with information such as the number of people in the room, the
|
||||
status of the room, and the description.
|
||||
|
||||
|
||||
|
||||
|
||||
Move a Room
|
||||
1. In the room list, select the desired rooms and click Move.
|
||||
2. Select the desired floor and click Confirm.
|
||||
|
||||
|
||||
|
||||
|
||||
Assign a License
|
||||
|
||||
90 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction
|
||||
You can view the premium licenses owned by the enterprise in the Order
|
||||
Management module and assign the licenses to rooms. Therefore, you can use the
|
||||
|
||||
remote control feature on the devices in the room.
|
||||
Procedure
|
||||
1. In the room list, do one of the following:
|
||||
Select rooms and click Assign License.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Assign on the right side of the desired room.
|
||||
2. Confirm your action in the pop-up window.
|
||||
3. You can see the assigned license under the column of License.
|
||||
|
||||
|
||||
|
||||
|
||||
91 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
Only one premium room license can be assigned to a meeting room.
|
||||
For meeting rooms that have been assigned a license, you can continue
|
||||
to use the Premium Meeting Room features for 14 days after the license
|
||||
expires. To ensure the continued use of services and features, it is
|
||||
recommended that you make a service purchase within these 14 days.
|
||||
|
||||
|
||||
Remove a License
|
||||
1. In the room list, select rooms and click Remove License.
|
||||
2. Confirm your action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
View Room Information
|
||||
1. In the room list, click the desired room name to view the room details.
|
||||
|
||||
Edit Room Information
|
||||
1. In the room list, click Edit on the right side of the desired room.
|
||||
|
||||
Delete Room
|
||||
1. In the room list, click Delete on the right side of the desired room.
|
||||
|
||||
Room Strategy
|
||||
Function Overview
|
||||
Support the configuration of the reservation strategy, release strategy, and room
|
||||
|
||||
|
||||
92 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
panel for meeting rooms to ensure effective management.
|
||||
Configure a Single Meeting Room
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace > Room Strategy
|
||||
3. Click the name of any meeting room or the configuration on the right.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the following configurations:
|
||||
|
||||
|
||||
|
||||
|
||||
Reservation Strategy
|
||||
💡 TIP
|
||||
If a template has been configured, you can use it directly for efficient
|
||||
configuration.
|
||||
|
||||
Room-based Reservation: Can configure whether reservation is supported on the
|
||||
|
||||
93 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
RoomPanel.
|
||||
Sensor auto-schedule: Need to use with Yealink smart sensors. After it is turned on, when
|
||||
the sensor detects a person, it will automatically make a room reservation.
|
||||
Advance reservation days: The number of days the meeting room can be reserved in
|
||||
advance.
|
||||
Single Appointment Duration: The duration of a single room reservation.
|
||||
Release Strategy
|
||||
💡 TIP
|
||||
If a template has been configured, you can use it directly for efficient
|
||||
configuration.
|
||||
|
||||
Release Strategy: After enabling, users will be allowed to release Room resources via
|
||||
doorplates/sensors, etc., before the schedule ends.
|
||||
Release Mode: Can select multiple release methods, support multiple selection.
|
||||
Automatic Release of Meeting Room for Untimely Check-in: Meeeting room
|
||||
schedules will be automatically released if not check in on time. Time rule requires the
|
||||
Meeting Room Check-in rule being enabled.
|
||||
When the sensor detects no presence persisting X minutes auto release
|
||||
RoomPanel
|
||||
💡 TIP
|
||||
If a template has been configured, you can use it directly for efficient
|
||||
configuration.
|
||||
|
||||
Display Settings: Support custom door page, home page background image, and
|
||||
corporate logo image
|
||||
|
||||
💡 NOTE
|
||||
This function applies only to the Yealink RoomPanel whose device mode
|
||||
is selected. If the thired-party conference sevice is used, skip this
|
||||
configuration item.
|
||||
|
||||
|
||||
|
||||
View the Room Details
|
||||
|
||||
94 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction
|
||||
You can manage meeting rooms on the room details page.
|
||||
|
||||
Go to the Details Page of a Room
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms > Rooms.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click the room name to go to the detail page of the room.
|
||||
|
||||
|
||||
|
||||
|
||||
95 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View the Details of a Room
|
||||
Procedure
|
||||
1. On the details page, do one of the following:
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to edit the room information.
|
||||
View information about the number of people in the room, the total number of devices,
|
||||
and the floor location of the room.
|
||||
Check the status of this meeting room.
|
||||
|
||||
|
||||
|
||||
|
||||
96 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View and Manage Devices in a Room
|
||||
Procedure
|
||||
1. On the details page, do one of the following:
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
97 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
98 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to switch to card or list view.
|
||||
Click Edit on the right side of the device to edit the device information.
|
||||
Click Details on the right side of the device or click the device name to go to the details
|
||||
page of the device.
|
||||
Click Release on the right side of the device to remove this device from this room.
|
||||
Select devices and click Update Firmware, Reboot, Rest to Factory, and Delete to
|
||||
manage devices in batch.
|
||||
Click Import, edit and upload the template to upload a batch of devices.
|
||||
Click Export and click
|
||||
|
||||
|
||||
|
||||
99 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
in the top-right corner to download the device list locally.
|
||||
Click Add to add devices to this room.
|
||||
|
||||
|
||||
|
||||
|
||||
100 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View the alarm list of a Room
|
||||
Procedure
|
||||
1. On the room details page, click Alarm to view the alarm events that exist for devices in that
|
||||
room.
|
||||
|
||||
|
||||
|
||||
|
||||
Remote Control
|
||||
Procedure
|
||||
1. On the room details page, click Remote Control to remotely control the device.
|
||||
|
||||
Digital Signage
|
||||
You can create digital signage and publish it to the screens of devices inside the
|
||||
meeting rooms. For more details, please refer to Digital Signage.
|
||||
|
||||
|
||||
|
||||
|
||||
101 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Insight
|
||||
Introduction
|
||||
By integrating spatial device data, YMCS offers a meeting room data insight
|
||||
feature that helps you more efficiently assess meeting room usage, understand
|
||||
resource utilization levels, and perform more effective and practical resource
|
||||
coordination.
|
||||
How to Use
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace> Insight.
|
||||
3. Set Working Time Period to calculate meeting room utilization rates.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Each small grid represents the aggregated number of rooms within the corresponding
|
||||
usage and occupancy levels. The deeper the green in the small grid, the greater the number
|
||||
of rooms it encompasses. Each large block represents the aggregated number of rooms
|
||||
with usage or occupancy that are below average, moderate, or above average.
|
||||
|
||||
|
||||
|
||||
|
||||
102 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Hovering over any block on the heatmap will display a selection box in the upper-left
|
||||
corner, enabling you to select the area. Multiple areas can be selected simultaneously, and
|
||||
the data in the right-hand room list will be filtered to display corresponding room
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Hovering over a grid on the heatmap will display the rooms' quantity, usage and occupancy
|
||||
level. Clicking a gird allows you to view the corresponding room data in the right-hand list.
|
||||
|
||||
|
||||
|
||||
|
||||
103 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
7. After clicking the usage rate/occupancy rate bar, the corresponding area on the heatmap
|
||||
will be selected, and the data in the right-hand list will be filtered to display the
|
||||
corresponding room information.
|
||||
|
||||
|
||||
|
||||
|
||||
Room Usage
|
||||
Real-time Statistical Indicators: You can view meeting room statistics, the number of
|
||||
meeting rooms in use, the number of available meeting rooms, occupancy statistics, and
|
||||
device statistics.
|
||||
Meeting Room Usage Heatmap Grid and Meeting Room List:：Displays the names of
|
||||
meeting rooms with excessively high/low utilization or occupancy rates, along with their
|
||||
allocated devices.
|
||||
|
||||
|
||||
|
||||
104 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Usage Rat: Total usage time of the meeting room within the selected time range / Total
|
||||
working time ("Usage time" refers to the duration of device calls during meetings in the
|
||||
meeting room).
|
||||
Occupancy Rate: The average maximum number of people detected per meeting within the
|
||||
selected time range / Capacity of the meeting room ("Maximum number of people detected"
|
||||
comes from the cameras/sensor devices in the meeting room, referring to the peak number
|
||||
of people detected during a meeting).
|
||||
|
||||
|
||||
Click Room Name to enter the specific meeting room details page.
|
||||
|
||||
|
||||
|
||||
|
||||
Insight Analysis: The AI assistant will summarize meeting room usage issues and provide
|
||||
suggestions.
|
||||
|
||||
|
||||
105 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Usage Trend: The trend of changes in the total usage frequency and duration of all
|
||||
meeting rooms within the current space ("Usage" refers to device calls in the meeting
|
||||
rooms).
|
||||
|
||||
|
||||
|
||||
|
||||
Device Usage
|
||||
Ranking of Meeting Call Duration: Select specific devices to view the call duration of the
|
||||
device series in each meeting room during the selected time period, along with the
|
||||
meeting room name and the quantity of the current devices in that meeting room.
|
||||
Call Frequency Ranking: Within the selected time range, rank the call duration and
|
||||
frequency for each device in the currently viewed device series. Sorting direction can be
|
||||
switched, and information such as device MAC address, model, and the meeting room it
|
||||
belongs to is provided.
|
||||
|
||||
|
||||
|
||||
106 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
107 / 171
|
||||
@@ -0,0 +1,460 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 661-680
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 661-680 of 953
|
||||
**Chunk:** 34
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Devices within a Room
|
||||
Add Devices
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Devices > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit device-related information.
|
||||
MAC: Enter the MAC address of the device. MAC must and can only contain 12 letters or
|
||||
numbers, the length is limited to 12-17 characters, the characters that can be entered
|
||||
include 0-9, A-z, "-", ":", for example, 00-15-65-1a-2b-3c, 00:15:65:1a:2b:3c,
|
||||
0015651a2B3c.
|
||||
Machine ID: Enter the Machine ID of the device. The Machine ID is the SN corresponding
|
||||
to the body sticker or the Machine ID displayed in the device status information.
|
||||
Model: Select the device model.
|
||||
Device Name: Enter the device name.
|
||||
Room: Select a room to which the device belongs.
|
||||
4. Click Save and the device is created; or click Save and Add Another and repeat the above
|
||||
operation to continue creating devices.
|
||||
|
||||
|
||||
|
||||
|
||||
108 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
FAQ
|
||||
109 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Do I need to add the room device again in the WorkSpace module
|
||||
if I have added it in the Device module?
|
||||
Meeting room devices are synchronized between Device and WorkSpace
|
||||
modules. If you have already added room devices in the Device module, you
|
||||
don't need to add them again in the WorkSpace module.
|
||||
Similarly, if you have added it to the WorkSpace module, you don't need to add
|
||||
it again in the Device module.
|
||||
Why can't I find the room device under a meeting room in the
|
||||
WorkSpace module after I added the room device in the Device
|
||||
module?
|
||||
Meeting room devices are synchronized between Device and WorkSpace
|
||||
modules.
|
||||
Please make sure that you have assigned the room device to a meeting room.
|
||||
You can view all meeting room devices, including unassigned devices, in the
|
||||
root node. Find the device in the root node and assign it to a meeting room.
|
||||
Once it's assigned, you will be able to see it in the meeting rooms.
|
||||
|
||||
|
||||
Import Devices
|
||||
Introduction
|
||||
If you want to add devices or modify device information quickly, you can import
|
||||
them in batch. You need to download the template, add devices in batch, or
|
||||
export the devices, edit the device information, and then import the file into
|
||||
YMCS.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Devices > Import.
|
||||
|
||||
|
||||
|
||||
|
||||
110 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Download Template. Edit the device information according to the guidance in the
|
||||
template.
|
||||
4. Save the file and upload it.
|
||||
5. Click Upload.
|
||||
|
||||
|
||||
|
||||
|
||||
111 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Manage Devices
|
||||
View the Device List
|
||||
1. Sign in to YMCS。
|
||||
2. Click WorkSpace > Rooms > Devices.
|
||||
3. In the device list, do one of the following:
|
||||
View device information such as MAC address and model. Click
|
||||
|
||||
|
||||
|
||||
|
||||
and choose the displayed fields.
|
||||
Click Advanced to customize filtering conditions and find devices. You can also click
|
||||
Save Search Label to save these filtering conditions as a label for future reference.
|
||||
In the label area, click any label to view all device information associated with that label.
|
||||
In the label area, click More > Label Management to sort, edit, or delete labels.
|
||||
|
||||
|
||||
|
||||
112 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Device Information
|
||||
1. In the device list, click Edit on the right side of the desired device.
|
||||
|
||||
Assign Devices to a Room
|
||||
1. In the device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
113 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
on the right side of the desired device and click Assign.
|
||||
2. Select a meeting room in the pop-up window and click Confirm.
|
||||
|
||||
Remove Devices from a Room
|
||||
1. Do one of the following:
|
||||
|
||||
|
||||
i. Click WorkSpace > Rooms > Devices.
|
||||
ii. In the device list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired device and click Release.
|
||||
|
||||
|
||||
iii. Click WorkSpace > Rooms > Rooms.
|
||||
iv. Click the desired room name to go to the details page.
|
||||
v. Switch to List View and click Release on the right side of the desired device.
|
||||
2. Confirm your action in the pop-up window.
|
||||
|
||||
Update Firmware
|
||||
1. In the device list, select devices and click Update Firmware.
|
||||
|
||||
114 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. In the pop-up window, select the firmware version. For more information, refer to firmware
|
||||
management.
|
||||
3. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the device has an associated accessory, you can also select whether to update the firmware
|
||||
for the accessory in the pop-up window.
|
||||
|
||||
|
||||
Reboot
|
||||
1. In the device list, select devices and click Reboot.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
If the device is on an active call, the device will reboot after the call ends.
|
||||
|
||||
|
||||
Reset to Factory
|
||||
1. In the device list, select devices and click Reset to Factory.
|
||||
2. Select Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
Factory reset will remove all the customized configurations of the device.
|
||||
|
||||
|
||||
Shut Down/Sleep/Wakeup
|
||||
1. In the device list, select devices and click Shut Down / Sleep / Wakeup.
|
||||
2. Confirm whether the device supports the operation. For supported devices, select
|
||||
Immediately or Scheduled Tasks to create a scheduled task and click Confirm.
|
||||
|
||||
Configuration
|
||||
1. In the device list, click Configure on the right side of the desired device. For more
|
||||
information, please refer to Device Config.
|
||||
|
||||
Delete Devices
|
||||
1. In the device list, select devices and click Delete.
|
||||
2. Confirm your action in the pop-up window.
|
||||
|
||||
💡 NOTE
|
||||
Platform-related data (except operation logs) will be erased after deletion and cannot be
|
||||
recovered.
|
||||
|
||||
|
||||
115 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View Device Details
|
||||
For more information, see the details page of the device.
|
||||
|
||||
|
||||
Device Details
|
||||
Introduction
|
||||
You can manage room devices on the device details page.
|
||||
|
||||
Go to the Details Page
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
Click WorkSpace > Rooms > Devices and click a device name to go to the detail page of
|
||||
the room.
|
||||
a. Click WorkSpace > Rooms > Rooms and click a room name.
|
||||
|
||||
|
||||
|
||||
|
||||
116 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
b. In the room details page, switch to list view and click the device name or Details on
|
||||
the right side to view the device details.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Basic Information
|
||||
On the device details page, view the device model, MAC address, and other basic
|
||||
information.
|
||||
|
||||
|
||||
|
||||
|
||||
117 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Device Overview
|
||||
On the device details page, click on Device Overview.
|
||||
|
||||
|
||||
|
||||
|
||||
Hardware Information
|
||||
Further check the device MAC, intranet IP, model, firmware version, connection
|
||||
method and other hardware information. Click More to go to Details page.
|
||||
|
||||
|
||||
|
||||
|
||||
118 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Active Alarms
|
||||
Check the active alarms of the device in the past 7 days. Click More to jump to
|
||||
Active Alarm List.
|
||||
|
||||
|
||||
|
||||
|
||||
Quick Entry
|
||||
The Quick Entry bar provides you with quick operations such as restarting,
|
||||
taking screenshots, and shutting down the computer, allowing you to quickly
|
||||
execute them with one click. Click More to jump to the Diagnosis page.
|
||||
|
||||
💡 NOTE
|
||||
|
||||
119 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
For details about whether the device supports a certain operation, please
|
||||
refer to: Supported Devices for Device Management Features.
|
||||
|
||||
|
||||
|
||||
Peripheral
|
||||
View associated/paired devices. Click View to go to Peripheral page.
|
||||
|
||||
|
||||
|
||||
|
||||
Account information
|
||||
Check the account information reported by the device.
|
||||
|
||||
|
||||
|
||||
|
||||
Working Status
|
||||
120 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
To view the cumulative online time of the device since the device was first reported, click
|
||||
|
||||
|
||||
|
||||
|
||||
to view the online start and end time, etc. Detailed information.
|
||||
Check how long the device has been working continuously.
|
||||
|
||||
💡 NOTE
|
||||
Only Android device multi-mode V31 and above support this function.
|
||||
|
||||
Check the usage of device storage space, memory and CPU.
|
||||
Click Refresh to refresh the current data.
|
||||
|
||||
|
||||
|
||||
|
||||
121 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Diagnose
|
||||
In the device details interface, click Diagnose.
|
||||
|
||||
|
||||
|
||||
|
||||
Perform basic operations such as Reboot, shutdown, Sleep and so on.
|
||||
Use methods such as packet capture and system log export to diagnose the device. For
|
||||
more information, see Device Diagnostics.
|
||||
View related files generated by the diagnosis in the history.
|
||||
|
||||
Configuration
|
||||
In the device details interface, click Configuration.
|
||||
|
||||
122 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
For more information, please refer to: Configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
Peripheral
|
||||
1. On the device details interface, click Peripheral.
|
||||
|
||||
|
||||
|
||||
|
||||
2. (Optional) Click to switch Topology / List View to view associated devices/paired devices.
|
||||
|
||||
💡 TIP
|
||||
For MVC devices that contain multiple camera devices, you can configure
|
||||
individual cameras in a targeted manner to ensure personalized operation
|
||||
of the camera.
|
||||
|
||||
123 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Switch to List View.
|
||||
|
||||
2. Click Camera Settings on the right side of the camera device (needs to be
|
||||
|
||||
online).
|
||||
|
||||
|
||||
|
||||
|
||||
3. Perform relevant configurations.
|
||||
|
||||
|
||||
Details
|
||||
On the device details interface, click Details. Check the detailed information of
|
||||
the device, such as: device online time, handle charging status, etc.; support
|
||||
manual re-acquisition.
|
||||
|
||||
|
||||
|
||||
|
||||
124 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Digital Signage
|
||||
Introduction
|
||||
You can use the "Digital Signage" service provided by YMCS to improve the
|
||||
efficiency of information transmission for your smart office building. By
|
||||
publishing welcome messages, important news, and thoughtful reminders on
|
||||
device screens in different spaces of the enterprise, you can add highlights to
|
||||
the smart office environment while effectively enhancing the promotional effect
|
||||
of the corporate culture image.
|
||||
|
||||
Prerequisites
|
||||
The YDS software on the playback device needs to be version V48.25.x or above.
|
||||
Before publishing digital signage, ensure that the device has enabled the screensaver
|
||||
function and selected information display (Settings > Display > Screensaver).
|
||||
Digital signage can only be published to the devices connected to rooms.
|
||||
|
||||
|
||||
|
||||
Procedure
|
||||
Upload and Manage Media Content
|
||||
1. Sign in to YMCS.
|
||||
2. Click Digital Signage > Content > Media.
|
||||
3. Click Add > Upload Image/Video / Add URL.
|
||||
|
||||
|
||||
|
||||
|
||||
125 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Upload media that meet the format and size requirements, and click Add.
|
||||
|
||||
💡 NOTE
|
||||
If you need to add a URL as a media, please enter the correct format starting with https.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
When the media occupies a large amount of memory, leaving the upload page
|
||||
during the upload process may cause the upload to be interrupted.
|
||||
You can click Transfer Queue to view the progress of media uploads.
|
||||
|
||||
|
||||
|
||||
126 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. After successful upload, manage the media in the media list.
|
||||
Select a group to view media in each group separately; supports adding, renaming, and
|
||||
deleting groups.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
127 / 171
|
||||
@@ -0,0 +1,336 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 681-700
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 681-700 of 953
|
||||
**Chunk:** 35
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Transcode to the right of any video material, then select the encoding format,
|
||||
resolution, and frame rate to transcode the video material. In what situations is it
|
||||
suitable to transcode video materials?
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
128 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Transcode records to view the transcode records of successful, in-progress, and failed
|
||||
transcodes over the past 7 days.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
129 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Publish to Teams. For more information, please refer to: Use Digital Signage in
|
||||
Microsoft Teams Rooms Pro Management.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
130 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Copy to duplicate the media.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
131 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Copy to to duplicate the media to another group.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
132 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Move to move the media to another group.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
133 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete, and choose whether to synchronize the deletion with associated digital
|
||||
signage.
|
||||
|
||||
|
||||
|
||||
|
||||
134 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Only video materials support transcoding.
|
||||
|
||||
Create and Manage Card Content
|
||||
You can combine and edit relevant media to create card content for display on
|
||||
devices.
|
||||
Create Card Content
|
||||
1. Sign in to YMCS.
|
||||
2. Click Digital Signage > Content > Card.
|
||||
3. Click Create.
|
||||
|
||||
|
||||
|
||||
|
||||
135 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Customize the content name and canvas ratio, and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
5. On the left side of the interface, select media or components; click/drag them to the
|
||||
canvas; click on the corresponding media or component on the canvas to select it; adjust
|
||||
the size, copy, paste, and arrange the media or components on the right side of the
|
||||
interface.
|
||||
Medias: Medias uploaded in the media management.
|
||||
Components: Components provided by the system, as explained below:
|
||||
Component NameDescriptionCalendarSupport adding meeting schedules.
|
||||
Only supports:
|
||||
|
||||
|
||||
136 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. O365 schedule synchronization
|
||||
2. Display of schedule information in meeting rooms equipped with door signs. If
|
||||
calendar integration services are not used or there are no door sign devices in the
|
||||
enterprise, this component cannot be practically used.Room InfoSupport adding and
|
||||
displaying meeting room information.ImageSupports adding and displaying images, as
|
||||
well as background color settings.VideoSupports adding and displaying videos.Web
|
||||
PageSupports adding URLs and displaying corresponding web pages. You can choose to
|
||||
add URLs by manual input, media library, or monitor wall.TextSupports adding and
|
||||
displaying text.CarouselSupports adding multiple images/videos to display them in
|
||||
rotation. Up to 10 media can be uploaded.MessageSupports adding messages that will
|
||||
scroll during playback.TimeSupports real-time display of the current date and
|
||||
time.SensorSupports selecting sensor devices within the enterprise and displaying
|
||||
corresponding temperature and humidity.QRSupports generating corresponding QR
|
||||
code images by inputting website URLs.
|
||||
|
||||
💡 NOTE
|
||||
A license is required for selecting the monitor wall in the Web Page
|
||||
widget.
|
||||
|
||||
1. Click Save to save the card content, or click Save and Publish to immediately publish the
|
||||
content to the device.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Card Content
|
||||
1. Sign in to YMCS.
|
||||
2. Click Digital Signage > Content > Card.
|
||||
|
||||
137 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Perform any of the following:
|
||||
Select a group to view the content within each group, you can adding, renaming, and
|
||||
deleting groups.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Publish to Teams. For more information, please refer to: Use Digital Signage in
|
||||
Microsoft Teams Rooms Pro Management.
|
||||
Click Edit on the right of any media to edit the card content.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
138 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Copy on the right of any media to copy the content.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
139 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Copy to on the right of any media to copy the content to another group.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
140 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Move on the right of any media to move the content to another group.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
141 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete on the right of any media and confirm in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
142 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Template management
|
||||
The template management has preset templates suitable for various occasions.
|
||||
In addition, you can also customize templates for reuse in the future.
|
||||
1. Log in to YMCS.
|
||||
2. Click Digital Signage > Template.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
Preview templates by category.
|
||||
Select the appropriate template according to your needs, hover the mouse over the
|
||||
thumbnail, and click Start Design. You will be redirected to Card Content editing
|
||||
interface, you can make further edits based on this template.
|
||||
|
||||
|
||||
143 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Hover over the thumbnail of any template and click
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
Hover over the thumbnail of any template and click
|
||||
|
||||
|
||||
|
||||
|
||||
144 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
Click Create templates in the upper right corner to customize the template for future
|
||||
use. For more information, please refer to: Card Content.
|
||||
|
||||
|
||||
|
||||
|
||||
PlayList
|
||||
Create PlayList
|
||||
Make cards/media into playlists for playback.
|
||||
1. Log in to YMCS.
|
||||
2. Click Digital Signage > PlayList > Create.
|
||||
|
||||
💡 NOTE
|
||||
A maximum of 50 content pages can be added to a single playlist.
|
||||
|
||||
|
||||
|
||||
145 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Name and group the playlist and click Next.
|
||||
|
||||
|
||||
|
||||
|
||||
Select the card/media/existing playlist on the left side of the interface; click to add to the
|
||||
editor on the right.
|
||||
You can drag the content to adjust the order; a preview video will be displayed for you at
|
||||
the top of the editor.
|
||||
You can check the box below to select a video and perform operations such as editing
|
||||
playback duration, deletion, etc.
|
||||
1. Click Save and the playlist will be saved; or click Save and Publish to publish playlist to
|
||||
|
||||
146 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
the device.
|
||||
|
||||
|
||||
|
||||
|
||||
Manage playlists
|
||||
1. Log in to YMCS.
|
||||
2. Click Digital Signage > PlayList.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
Select a group to view the playlists in each group separately; support adding, renaming,
|
||||
and deleting groups.
|
||||
Click Edit on the right side of any playlist to edit the playlist content.
|
||||
Click on the right side of any playlist
|
||||
|
||||
|
||||
147 / 171
|
||||
@@ -0,0 +1,387 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 701-720
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 701-720 of 953
|
||||
**Chunk:** 36
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Move; or check the playlist, Click Move to move the content to another group.
|
||||
Click on the right side of any playlist
|
||||
|
||||
|
||||
|
||||
|
||||
148 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete, or check the playlist, Click Delete and confirm twice in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
Publish Information to Specific Device/Space
|
||||
1. Log in to YMCS.
|
||||
|
||||
|
||||
149 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Perform any of the following actions:
|
||||
Click Digital Signage > Content > Media , and click Publish on the right of any media.
|
||||
Click Digital Signage > Content > Card , and click Publish on the right of any content.
|
||||
Click Digital Signage > PlayList, and click Publish on the right of any playlist.
|
||||
Click Digital Signage > Publish > Create.
|
||||
3. Edit the specific information for the publish.
|
||||
Publish Name: Name the publish.
|
||||
Type: Select media/card/playlist.
|
||||
Publish Content : Select the content to be published, and you can click Details on the
|
||||
right for a preview.
|
||||
Content Playback Mode: Select the time and cycle for content playback. The release
|
||||
time supports selecting a time zone.
|
||||
Publish Object: Select the specified device or space as the publish object.
|
||||
Publish Scope: Select where the digital signage will be played.
|
||||
4. Click Temporarily Save to temporarily save the publish in Publish Management; click
|
||||
Publish to execute the publish according to the set time.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Playback methods include weekly repetition and one-time release,
|
||||
supporting resource early download.
|
||||
Resource early download: Video content is downloaded in advance
|
||||
without affecting the device's performance
|
||||
When selecting the space, the playback device bound to this space will
|
||||
|
||||
150 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
automatically execute the publishing task, and the playback will be
|
||||
automatically canceled when the device is unbound from the space
|
||||
|
||||
Publish Management
|
||||
You can manage all publish actions and trace information such as publish time
|
||||
and personnel.
|
||||
1. Log in to YMCS.
|
||||
2. Click Digital Signage > Publish.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
151 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right of a publish to enable/disable the publish.
|
||||
|
||||
💡 NOTE
|
||||
Publishes with incomplete content cannot be enabled and need to be filled in before
|
||||
publishing.
|
||||
|
||||
|
||||
Click Edit on the right of any publish to edit it.
|
||||
Click Delete on the right of any publish, or select content and click Delete .
|
||||
|
||||
|
||||
|
||||
|
||||
Digital Signage Effect
|
||||
In the published devices, the digital signage effect is as follows:
|
||||
|
||||
|
||||
152 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Monitor
|
||||
In the monitor page, you can understand the status of all released content in
|
||||
real-time.
|
||||
1. Log in to YMCS.
|
||||
2. Click Digital Signage > Monitor.
|
||||
|
||||
|
||||
|
||||
|
||||
3. (Optional) Select a region to view the publishing tasks in the corresponding region.
|
||||
4. (Optional) Filter the corresponding tasks by MAC/task name, task status, and publish time.
|
||||
Each card corresponds to a publishing task, and the publishing status will be displayed
|
||||
on the task thumbnail: In Progress/Device Busy/No Content/Offline.
|
||||
153 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
In Progress: The device is playing digital signage.
|
||||
Device Busy: The device is currently in use and the digital signage is paused.
|
||||
No Content: The device is not currently playing any content.
|
||||
Offline: No device detected or YDS is offline.
|
||||
|
||||
Click Cancel Play to immediately stop the device from playing the current task, and the
|
||||
device execution status will change to "Manual End".
|
||||
Click Remove Device to delete the device from the current page, but it will not cause the
|
||||
device to be unbound from the platform. If you need to unbind, please go to the "Device
|
||||
Management" page.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Related Task to view task execution details. Supports one-click adding tasks on the
|
||||
154 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
details page.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Sleep, select Immediately/Scheduled to screen off the device's display.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
155 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Power Off, select Immediately/Scheduled to shut down the device.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
156 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Remote Control, enter the Remote Control page.
|
||||
|
||||
💡 NOTE
|
||||
Only if you have a remote control license, your interface will display the entrance to this
|
||||
function.
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
157 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Restart, select Immediately/Scheduled to restart the device.
|
||||
|
||||
💡 NOTE
|
||||
The operational support for various tasks is as follows:
|
||||
|
||||
|
||||
Task Can Remo Vie Turn Shu Res Remo Devic Go to
|
||||
cel ve w off t tar te e device
|
||||
typ pla devi tas scre do t contr detai details
|
||||
e y ce k en wn ol ls page
|
||||
|
||||
In Sup Sup Supp Sup Sup Supp Supp Support
|
||||
Prog port por ort por por ort ort
|
||||
|
||||
158 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
ress t t t
|
||||
|
||||
Devi Sup Sup Supp Sup Sup Supp Supp Support
|
||||
ce port por ort por por ort ort
|
||||
Bus t t t
|
||||
y
|
||||
|
||||
No Sup Supp Sup Sup Supp Supp Support
|
||||
Cont por ort por por ort ort
|
||||
ent t t t
|
||||
|
||||
Offli Supp Sup Supp Sup Sup Supp Supp Support
|
||||
ne ort por ort por por ort ort
|
||||
t t t
|
||||
|
||||
Whether the screen can be turned to sleep, turned off, or remotely controlled,
|
||||
please refer to the actual support of the device.
|
||||
|
||||
|
||||
|
||||
|
||||
159 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Use Digital Signage in Microsoft Teams
|
||||
Rooms Pro Management
|
||||
Introduction
|
||||
It supports the use and publishing of digital signage created by YMCS in
|
||||
Microsoft Teams Rooms Pro Management.
|
||||
|
||||
Prerequisites
|
||||
Teams App has Microsoft Teams Rooms Device with Pro License, and the version is 5.1 and
|
||||
above.
|
||||
The system version is Windows 10/11.
|
||||
|
||||
Procedure
|
||||
Get content in YMCS
|
||||
1. Sign in to YMCS.
|
||||
2. In the Workspace Management, click Digital Signage > Content.
|
||||
If you need to obtain the media content, enter Media and click
|
||||
|
||||
|
||||
|
||||
|
||||
160 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Publish to Teams on the right side of any media.
|
||||
|
||||
|
||||
|
||||
|
||||
161 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
If you need to obtain the card content, enter Card and click
|
||||
|
||||
|
||||
|
||||
|
||||
162 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Publish to Teams on the right side of any card.
|
||||
|
||||
|
||||
|
||||
|
||||
163 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
1. Click Copy in the pop-up window; meanwhile, you can click Re-generate to regenerate the
|
||||
link and then copy a new one.
|
||||
|
||||
💡 NOTE
|
||||
The original link will be invalid after it is regenerated. If you have published the content to
|
||||
Microsoft Teams Rooms Pro Management, you need to replace the source in the digital
|
||||
signage with the new link.
|
||||
|
||||
|
||||
|
||||
|
||||
164 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Publish content to Microsoft Teams Rooms Pro Management
|
||||
1. Access Microsoft Teams Rooms Pro Management.
|
||||
2. Log in to the administrator account and select the Windows device assigned the
|
||||
Professional Edition meeting room license.
|
||||
3. Click Settings > Digital Signage > Add Source.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit relevant information and publish the digital signage. Among them, when configuring
|
||||
to Select Source, you need to select Custom and fill in the link you obtained in YMCS.
|
||||
For complete operations, please refer to: Teams Documentation—How to configure third-
|
||||
party digital signage.
|
||||
|
||||
💡 NOTE
|
||||
MOV Videos may have jerky playback in Teams Digital Signage, so it is
|
||||
recommended to use MP4 Video. In addition, to avoid cropping, we
|
||||
recommend using 16:9 ratio content.
|
||||
If you have performed a Re-generate operation in YMCS, the original
|
||||
link will be invalid. You need to ensure that the source is the latest link
|
||||
before the digital signage can take effect.
|
||||
|
||||
|
||||
|
||||
|
||||
165 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage digital signage in Rooms of Microsoft Teams Rooms Pro
|
||||
Management
|
||||
For Rooms that have been configured with digital signage, you can manage
|
||||
them in Rooms.
|
||||
1. Access Microsoft Teams Rooms Pro Management.
|
||||
2. Log in to the administrator account and select the Windows device assigned the
|
||||
Professional Edition meeting room license.
|
||||
3. Click Rooms.
|
||||
4. Select a room that has configured with digital signage.
|
||||
5. Click Settings > Digital Signage. For more information, please refer to: Teams
|
||||
Documentation.
|
||||
|
||||
|
||||
|
||||
|
||||
166 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Calendar
|
||||
Introduction
|
||||
In the Calendar, you can overview the information and status of all meeting
|
||||
rooms of the enterprise at each time period, including meeting time and other
|
||||
information.
|
||||
|
||||
View Calendar
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace > Calendar.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Check the conference room status through the following operations:
|
||||
|
||||
|
||||
|
||||
|
||||
: Filter meeting rooms with a specified capacity.
|
||||
|
||||
167 / 171
|
||||
@@ -0,0 +1,383 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 721-740
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 721-740 of 953
|
||||
**Chunk:** 37
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
168 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
：Refresh the interface.
|
||||
|
||||
|
||||
|
||||
|
||||
: Select a date.
|
||||
Hover the mouse over any conference room on the left to view the detailed information
|
||||
of the conference room, including location, capacity, conference room type, etc.
|
||||
Click the name of any conference room on the left to view the schedule of that
|
||||
conference room.
|
||||
Click any schedule to view the meeting time. As an administrator, you can delete the
|
||||
schedule.
|
||||
|
||||
Synchronize O365 calendar to YMCS
|
||||
Prerequisites
|
||||
You have integrated O365 calendar in Integration.
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace > Calendar.
|
||||
|
||||
|
||||
|
||||
|
||||
3. (Optional) If the O365 calendar has not been bound yet, please click Setting.
|
||||
4. If the O365 calendar has been successfully bound, the calendar data will be automatically
|
||||
synchronized to YMCS; you can also click Sync in the upper right corner to manually
|
||||
|
||||
|
||||
169 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
synchronize the calendar data immediately.
|
||||
|
||||
💡 NOTE
|
||||
The scope of synchronized calendar data includes: calendar resource
|
||||
accounts in O365 and calendar data associated with each resource
|
||||
account.
|
||||
|
||||
|
||||
Synchronize meeting information on RoomPanel to YMCS
|
||||
Prerequisites
|
||||
Users reserve meetings through YRD software on RoomPanel, and the
|
||||
RoomPanel used must be assign to the room.
|
||||
|
||||
💡 NOTE
|
||||
Please contact Yealink Support to obtain the corresponding firmware
|
||||
version of RoomPanel.
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Workspace > Calendar.
|
||||
|
||||
|
||||
|
||||
|
||||
Meetings scheduled through RoomPanel will be displayed in the corresponding meeting
|
||||
room on the Calendar page.
|
||||
|
||||
170 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Reservation, cancellation, and other operations performed by users through RoomPanel
|
||||
will be synchronized to YMCS in real-time.
|
||||
If the bound room is an O365 calendar resource account, the appointment, deletion, and
|
||||
modification of the schedule will also be synchronized in the O365 calendar.
|
||||
|
||||
|
||||
|
||||
|
||||
171 / 171
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Floor Plan
|
||||
Introduction
|
||||
Maintain the floor plan of the enterprise space to visually manage floor
|
||||
resources. And these can be displayed on devices at various locations through
|
||||
digital signage.
|
||||
How to Use
|
||||
Create Space
|
||||
Click Workspace > Floor Plan> Go Now to create the enterprise space.
|
||||
Create Map
|
||||
Method 1
|
||||
1. Enter the floor space node.
|
||||
2. Click Create directly.
|
||||
|
||||
|
||||
|
||||
|
||||
Adjust the canvas scale and upload the background to create the map base according to
|
||||
the actual spatial distribution of the floor.
|
||||
Drag resources from the left panel to insert meeting rooms, workstations, drawing tools,
|
||||
signboards, etc.
|
||||
You can bind meeting room resources to specific meeting rooms.
|
||||
Use the page settings on the right panel to adjust the canvas scale, background, zoom
|
||||
method, and transparency.
|
||||
|
||||
|
||||
1 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Method 2
|
||||
1. Click Import Floorplan（Supports importing image or CAD file and modeling as 2D maps
|
||||
and 3D maps.）
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Floor Management
|
||||
Click Floor Plan, select the floor, and view information such as the space
|
||||
name, time, floor plan.
|
||||
Supports switching between 2D and 3D maps.
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Use Digital Signage to display maps.
|
||||
Click Copy URL
|
||||
|
||||
|
||||
|
||||
|
||||
Click Digital Signage > Content > Custom Card > Create.
|
||||
In the widget pane, select Web page and paste the URL copied from Floor Plan into the
|
||||
editor on the right.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Save and set up a task to publish the map floor to the devices.
|
||||
|
||||
|
||||
|
||||
|
||||
5 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Monitor Wall
|
||||
Introduction
|
||||
By viewing the monitor wall, you can have a comprehensive and real-time grasp
|
||||
of various data and conditions of the device of each enterprise without the need
|
||||
for frequent manual refreshes.
|
||||
|
||||
Prerequisites
|
||||
Please contact and provide the email of your account to the Yealink Support in order to
|
||||
enable this feature.
|
||||
Only super admin can use this feature, normal users can obtain a link from the super admin
|
||||
and enter the link to view the monitor wall.
|
||||
|
||||
View the Monitor Wall
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Hover the mouse over the thumbnail of the monitor wall and click View.
|
||||
|
||||
|
||||
|
||||
|
||||
4. View various indicators of the device in real time on the monitor wall.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
N Description
|
||||
u
|
||||
m
|
||||
be
|
||||
r
|
||||
|
||||
1 Current time.
|
||||
|
||||
2 The total number of rooms.
|
||||
|
||||
3 Device status. Count the total number of devices and the number and
|
||||
proportion of online/offline/pending devices.
|
||||
|
||||
4 Model statistics. Count different types of device and their quantities.
|
||||
|
||||
5 Top 5 Active Alarm Types. Count the 5 largest existing alarm types.
|
||||
|
||||
6 Active alarm records. Count the largest number of active alarms and
|
||||
their detailed information, including: device name, room name, and last
|
||||
alarm time.
|
||||
|
||||
7 The number of new alarms in the past 7 days. Statistics of the number
|
||||
and severity of daily alarms in the past 7 days.
|
||||
|
||||
8 Problem Feedback Record.Count the feedback and their detailed
|
||||
|
||||
7 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
information, including: content, room name,and feedback time.
|
||||
|
||||
Set the Monitor Wall
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Settings in the lower right corner of the thumbnail of the monitor wall.
|
||||
|
||||
|
||||
|
||||
|
||||
Data Refresh Period: Set the time for automatic refresh of the monitor wall. It will be
|
||||
updated with real-time data at that frequency.
|
||||
Access Whitelist: If not enabled, devices under any IP can access the monitor wall
|
||||
through links; if enabled, only IP addresses in the whitelist can access.
|
||||
|
||||
|
||||
8 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Copy the Link of the Monitor Wall
|
||||
You can obtain the link of the monitor wall, which can be accessed by users in
|
||||
the IP whitelist. They can view the specific content of the monitor wall, or
|
||||
display it as material/content on Yealink Digital Signage or Third Party Digital Signage.
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click Monitor Wall.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
> Copy Link in the lower right corner of the thumbnail of the monitor wall.
|
||||
4. Make relevant settings, click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
9 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
10 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Teams Application Intergration
|
||||
For PC Client
|
||||
|
||||
|
||||
|
||||
|
||||
11 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
12 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
💡 NOTE
|
||||
You need to enable Teams notifications to receive device alert notifications and meeting
|
||||
room feedback.
|
||||
|
||||
|
||||
Add an integrated application
|
||||
Procedure
|
||||
1. Click Apps.
|
||||
2. Search YMCS for the result.
|
||||
3. Click Add to add apps to the Chat.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Log in to YMCS
|
||||
|
||||
|
||||
|
||||
|
||||
13 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Rooms
|
||||
Click Rooms > Room Card to view the device status, capacity, license,
|
||||
deployment code, room capacity, expiration date, and other details.
|
||||
|
||||
|
||||
|
||||
|
||||
14 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Add a Room
|
||||
1. Click Rooms > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Input the information about the room.
|
||||
|
||||
|
||||
|
||||
|
||||
15 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Bind Device
|
||||
Method 1
|
||||
Click Room > Bind Device to connect the device to the meeting room.
|
||||
|
||||
|
||||
|
||||
|
||||
Method 2
|
||||
Click Room Card > Bind Device to connect the device to the meeting room.
|
||||
|
||||
|
||||
|
||||
|
||||
16 / 91
|
||||
@@ -0,0 +1,322 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 741-760
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 741-760 of 953
|
||||
**Chunk:** 38
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Devices
|
||||
Click Devices > Device Card to view the device's basic information and manage
|
||||
devices.
|
||||
|
||||
|
||||
|
||||
|
||||
Alarm
|
||||
Click Alarm > Alarm Card to access the alarm level and reasons.
|
||||
|
||||
|
||||
|
||||
|
||||
17 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click Alarm Device Card to view alarm details. Click Complete Processing if this alarm
|
||||
issue has been handled.
|
||||
|
||||
|
||||
|
||||
|
||||
18 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
19 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Feedback
|
||||
Display the list of feedback issues for the meeting room, including pending and
|
||||
resolved issues. Click Room Card to view details.
|
||||
|
||||
|
||||
|
||||
|
||||
20 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Task
|
||||
The task record list includes fields such as execution time, task name, task
|
||||
mode, task type, execution result, and operation.
|
||||
|
||||
|
||||
|
||||
|
||||
Settings
|
||||
Here you can choose rooms to receive alarms and feedback in Chat; to
|
||||
configure the room's alarm rule, please go Enterprise
|
||||
|
||||
|
||||
|
||||
|
||||
21 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Chat
|
||||
You can use YMCS to help you manage devices, receive device alarms, and room
|
||||
feedback.
|
||||
|
||||
|
||||
|
||||
|
||||
For Mobile Client
|
||||
Add an integrated application
|
||||
Procedure
|
||||
22 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Click Apps.
|
||||
2. Search YMCS for the result.
|
||||
3. Click Add to add apps to the Chat.
|
||||
|
||||
|
||||
|
||||
|
||||
23 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Log in to YMCS
|
||||
|
||||
|
||||
|
||||
|
||||
24 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. You can use the same features on the mobile version as on the web version.
|
||||
|
||||
|
||||
|
||||
|
||||
25 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
27 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. You need to enable Teams notifications to receive device alert notifications and meeting
|
||||
room feedback.
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Issue
|
||||
Alarm
|
||||
Introduction
|
||||
When a problem occurs to the device, for example, the call failure or firmware
|
||||
update failure will be reported to YMCS. You can quickly locate the problem by
|
||||
viewing the alarm details and diagnosing the devices.
|
||||
|
||||
Procedure
|
||||
Go to Alarm List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Workspace > Issue > Alarm.
|
||||
(Optional) Select the room hierarchy in the left-side directory.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Alarm List
|
||||
View alarm events, alarm severity, and other information in the alarm list.
|
||||
You can filter alarms based on their severity level, including common, primary, and critical
|
||||
alarms.
|
||||
Additionally, you can filter alarms based on their status, including active, resolved, and
|
||||
|
||||
|
||||
31 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
ignored alarms.
|
||||
|
||||
Export Alarm Records
|
||||
1. In the alarm list, click Export in the top-right corner.
|
||||
2. Click
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
|
||||
Alarm Mute
|
||||
You can enable the alarm mute feature for room devices. Once enabled, the
|
||||
platform will refrain from triggering new alarms during the specified time
|
||||
period.
|
||||
1. In the alarm list, click Alarm Mute in the top-right corner.
|
||||
32 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Set the parameters and click Save.
|
||||
|
||||
💡 NOTE
|
||||
The alarm mute supports separate settings for different meeting rooms
|
||||
|
||||
View Alarm Details
|
||||
1. In the alarm list, click Details on the right side of any alarm.
|
||||
|
||||
|
||||
|
||||
|
||||
33 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Do one of the following:
|
||||
Click Active Alarms or Historical Alarms to view the corresponding alarms.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Alarm card to view specific information, including Alarm ID, troubleshooting
|
||||
suggestions and so on.
|
||||
Click Complete Processing to mark it as resolved.
|
||||
Click Export to export data.
|
||||
|
||||
|
||||
|
||||
|
||||
34 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Feedbacks
|
||||
Introduction
|
||||
When troubles occur on a device, on-site personnel can fill out feedback on the
|
||||
device, and the feedback will be summarized in the list of YMCS for efficient
|
||||
handling by administrators.
|
||||
|
||||
Prerequisites
|
||||
The device is connected to YMCS and the corresponding enterprise. For more
|
||||
information, please refer to: Connecting to YMCS.
|
||||
|
||||
Procedure
|
||||
|
||||
💡 NOTE
|
||||
If the enterprise has subscribed to the Advanced Meeting Room Order
|
||||
and enabled Servicenow, the received feedback will be synchronized to
|
||||
the Service Now.
|
||||
|
||||
Go to the Feedback List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Workspace > Issue > Feedback (Bata).
|
||||
(Optional) Select the meeting room hierarchy in the left-side directory.
|
||||
|
||||
|
||||
|
||||
|
||||
35 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Marking as in Process
|
||||
Mark the feedback as in process, indicating that someone is following up on the
|
||||
issue.
|
||||
1. Click on Process on the right side of any feedback and confirm in the pop-up window.
|
||||
Marking as Completed
|
||||
Mark the feedback as completed, indicating that the current issue has been
|
||||
resolved.
|
||||
1. Click on Resolved on the right side of any feedback.
|
||||
2. Enter the remarks in the pop-up window and click Confirm.
|
||||
Viewing Feedback
|
||||
1. (Optional) Enter the feedback content in the search box for filtering.
|
||||
2. Click on Active Issues / Resolved Issues to view the corresponding feedback.
|
||||
|
||||
General Issue
|
||||
How can on-site personnel submit feedback on the device?
|
||||
1. (Using MeetingBoard as an example) On the device's touchscreen, go to Device Settings >
|
||||
General > Feedback.
|
||||
2. Select the urgency level of the issue and describe the problem.
|
||||
3. Click Submit.
|
||||
|
||||
|
||||
|
||||
Notification
|
||||
Add Notification
|
||||
Introduction
|
||||
You can set alarm notification strategies based on notification recipients,
|
||||
notification cycles, and other dimensions. When a device triggers a relevant
|
||||
alarm and the notification strategy is enabled, the designated recipients will
|
||||
receive notifications via email.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Workspace Device > Issue > Notification > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
36 / 91
|
||||
@@ -0,0 +1,565 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 761-780
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 761-780 of 953
|
||||
**Chunk:** 39
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the basic information and click Next.
|
||||
|
||||
💡 TIP
|
||||
For Alarms, including Offline, Wireless mic low power, High CPU usage, Low storage space,
|
||||
Network disconnection, Peripheral offline, Sensor low power, and High memory usage, you
|
||||
can set up a recovery notification to be notified when they are resolved.
|
||||
|
||||
|
||||
|
||||
|
||||
Name: Edit the notification name.
|
||||
Content: Select Feedbacks / Alarms as the content.
|
||||
Rooms: Select rooms to which the notification policy applies.
|
||||
|
||||
|
||||
37 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Recipient: Select the notification recipient. You can select the emails of the enterprise
|
||||
administrators or sub-accounts.
|
||||
4. Click Alarms > Advanced Settings. You can customize the content of the alarm event
|
||||
notifications you want to receive, and for the following types of alarm events, the system
|
||||
supports automatic recovery status determination, and you can choose whether to receive
|
||||
the corresponding recovery notifications.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
You can set recovery notifications for the following alarm events: Offline,
|
||||
Peripheral offline, Wireless mic low power, Sensor lower power, and
|
||||
Network disconnection. You will be notified when these alarm events are
|
||||
resolved.
|
||||
|
||||
5. Click Confirm.
|
||||
|
||||
💡 NOTE
|
||||
Once a notification is created, it is enabled by default. You can enable/
|
||||
disable it in the notification policy list.
|
||||
|
||||
|
||||
|
||||
Manage Notification
|
||||
Go to the Alarm Notification List
|
||||
1. Sign in to YMCS.
|
||||
|
||||
38 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Workspace Device > Issue > Notification.
|
||||
|
||||
|
||||
|
||||
|
||||
View Recipients
|
||||
1. In the alarm notification list, click View under the column of Recipient to
|
||||
|
||||
enable or disable the alarm.
|
||||
|
||||
Enable/Disable Notification Strategy
|
||||
1. In the alarm notification list, click
|
||||
|
||||
|
||||
|
||||
|
||||
39 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
the toggle under the column of Status to the enable or disable the alarm.
|
||||
|
||||
View Alarm Content
|
||||
1. In the alarm notification list, click View under the column of Content to view
|
||||
|
||||
|
||||
40 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
the alarm content.
|
||||
|
||||
Edit Alarm Notification
|
||||
1. In the alarm notification list, click Edit on the right side of the desired strategy.
|
||||
|
||||
Delete Alarm Notification
|
||||
1. In the alarm notification list, click Delete on the right side of the desired
|
||||
|
||||
strategy and confirm the action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
Alarm Rule
|
||||
Introduction
|
||||
You can configure alarm rules for various types of alarm events based on your
|
||||
enterprise's actual alarm handling practices. This includes trigger times,
|
||||
detection thresholds, and more.
|
||||
|
||||
Create an Alarm Rule
|
||||
Procedure
|
||||
|
||||
💡 NOTE
|
||||
If the enterprise has subscribed to the YMCS Room Pro License and
|
||||
enabled ServiceNow, the alarm will be synchronized to the Service Now.
|
||||
|
||||
1. Log in to YMCS.
|
||||
2. Click Issue > Alarm Rule > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Configure alarm rules.
|
||||
Name: Edit the rule name.
|
||||
Rule Content: Check the events included in the rule and define the trigger rules and
|
||||
alarm levels for each event.
|
||||
Associate Rooms: Select the meeting rooms to which the rule applies.
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Android/Smart Screen/Windows conference devices have newly added
|
||||
support for the Teams not sign in alarm type.
|
||||
|
||||
|
||||
42 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Manage Alarm Rules
|
||||
1. Log in to YMCS.
|
||||
2. Click Click Issue > Alarm Rule.
|
||||
3. Perform the following operations:
|
||||
View the content, status, and creation time information of each rule. (Optional) Click
|
||||
|
||||
|
||||
|
||||
|
||||
43 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to customize display fields.
|
||||
In the rule list, click the toggle under any rule's status
|
||||
|
||||
|
||||
|
||||
|
||||
44 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
/
|
||||
|
||||
|
||||
|
||||
|
||||
to enable/disable the rule.
|
||||
In the rule list, click the edit icon on the right side of any rule to edit the rule information.
|
||||
In the rule list, click the delete icon on the right side of any rule to delete the rule. The
|
||||
meeting room associated with the original rule will automatically be disassociated.
|
||||
|
||||
|
||||
|
||||
|
||||
45 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
46 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Scheduled Task
|
||||
Add Scheduled Task
|
||||
|
||||
💡 NOTE
|
||||
USB Management is newly upgraded for Personal Devices. For more
|
||||
information about adding tasks of USB devices, see Ass USB Device Tasks.
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Tasks > Scheduled Tasks.
|
||||
3. Click Add.
|
||||
4. Select a range and click Next.
|
||||
Device Type: Select Phone Device, Room Device, or USB Device.
|
||||
Devices: Select All, Site, Group,or Custom.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Edit the task information.
|
||||
Task Name: Enter the task name.
|
||||
Execution Mode: Select the execution mode as Immediately, One-time Task, Daily,
|
||||
Every Week, or Every Month.
|
||||
|
||||
|
||||
|
||||
|
||||
47 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Task Description
|
||||
modes
|
||||
|
||||
Instant The task will be executed immediately.
|
||||
task
|
||||
|
||||
One- The task will be executed once at the scheduled time you set.
|
||||
time
|
||||
task
|
||||
|
||||
Recurrin The task will be executed periodically at the scheduled time you
|
||||
g task set (daily/weekly/monthly).
|
||||
|
||||
Task: Select the task type.
|
||||
|
||||
Task Execution Rule Does
|
||||
Nam Conferenc
|
||||
e e Room
|
||||
Equipment
|
||||
Support
|
||||
|
||||
Rebo Restart the selected device. √
|
||||
ot
|
||||
|
||||
|
||||
48 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Reset Restore factory settings for the selected device. √
|
||||
to
|
||||
Facto
|
||||
ry
|
||||
|
||||
Confi Back up all device configuration files to avoid √
|
||||
g situations where configuration files cannot be
|
||||
Back recovered due to damage.
|
||||
up
|
||||
|
||||
Updat Push resource files to the selected device. The same √
|
||||
e type of resource only allows one selection for
|
||||
Resou transmission, sending global parameters to the
|
||||
rce selected device.
|
||||
Files
|
||||
|
||||
Updat Update firmware for the selected device. If multiple √
|
||||
e different types of devices are selected, the firmware
|
||||
Firm supported by different types of devices will be
|
||||
ware retrieved.
|
||||
|
||||
Reset The display will be reset to the device's built-in default √
|
||||
Scree display parameters.
|
||||
n
|
||||
|
||||
6. Click Complete. The task will be executed according to your settings.
|
||||
|
||||
💡 NOTE
|
||||
If you add multiple tasks for one device, those tasks are lined up to run in order
|
||||
of their configured execution time.
|
||||
If the device is offline, the task will not be executed.
|
||||
If the task has not expired, it will be executed after the device is restored to an
|
||||
online state.
|
||||
|
||||
|
||||
Manage Scheduled Tasks
|
||||
|
||||
49 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
USB Management is newly upgraded for Personal Devices. For more
|
||||
information about managing USB device tasks, see Manage USB Device
|
||||
Tasks.
|
||||
|
||||
|
||||
Access the Scheduled Task List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Device > Tasks > Scheduled Tasks.
|
||||
|
||||
View the Scheduled Task List
|
||||
You can view the task type, the execution status, the execution mode, and other
|
||||
information.
|
||||
Click View under the Devices tab to see which devices are executing this task and their
|
||||
device types.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Execution Record
|
||||
1. In the scheduled task list, click Execution Record on the right side of the desired task.
|
||||
2. The record includes the execution time and the execution status.
|
||||
3. (Optional) Click Execution Details to view the execution result and the error reason of each
|
||||
executing device.
|
||||
|
||||
|
||||
|
||||
|
||||
50 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Scheduled Tasks
|
||||
4. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired pending or paused task and select Edit.
|
||||
|
||||
Pause Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the recurring task and select Pause.
|
||||
|
||||
Resume Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired paused task and select Continue. If the task has not
|
||||
expired, the task will be executed and completed on the time you set.
|
||||
|
||||
|
||||
51 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
End Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> End.
|
||||
|
||||
💡 NOTE
|
||||
If you terminate an executing scheduled task, the task will continue to be
|
||||
executed until it completes. However, if you terminate a one-time or
|
||||
recurring task, it will no longer be executed.
|
||||
|
||||
Delete Scheduled Tasks
|
||||
1. In the scheduled task list, click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
52 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Workspace Management
|
||||
Features and Their Supported
|
||||
Devices
|
||||
💡 TIP
|
||||
*Please contact Yealink Support for the specific firmware version that is supported.
|
||||
-This feature belongs to YMCS and does not require support from terminal devices.
|
||||
Blank cells indicate that the device model does not support this feature.
|
||||
|
||||
|
||||
Feature Mee Mee MV Ro Ro Tou Tou Contr
|
||||
tin tin C om om ch ch ol
|
||||
gBa gBo Pan Ca Pan Pan Syst
|
||||
r ard el st el el em
|
||||
(In (Pe
|
||||
dep riph
|
||||
end eral
|
||||
ent )
|
||||
)
|
||||
|
||||
Rooms Dashboard - - - - - - - -
|
||||
Management Loc Manage - - - - - - - -
|
||||
ati
|
||||
on devices
|
||||
Dir by
|
||||
ect room
|
||||
ory
|
||||
|
||||
Third-party √（
|
||||
calendar YRD
|
||||
sync
|
||||
V14
|
||||
7.22
|
||||
.0
|
||||
|
||||
53 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
or
|
||||
lat
|
||||
er
|
||||
）
|
||||
|
||||
Devi Device Con Via √ √ √ √ √ -
|
||||
ce Manag nec Auto
|
||||
Man ement t to Provisi
|
||||
age Pla oning
|
||||
men tfo Server
|
||||
t rm Via √ √ √ √ √ -
|
||||
DHCP
|
||||
Option
|
||||
|
||||
Batch √ √ √ √ - √
|
||||
deploy
|
||||
ment
|
||||
via
|
||||
YMCS
|
||||
web
|
||||
Interfa
|
||||
ce with
|
||||
MAC &
|
||||
SN
|
||||
|
||||
Deploy * * * √ -
|
||||
ment Onl
|
||||
via y
|
||||
deploy Mee
|
||||
ment tin
|
||||
code gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
|
||||
|
||||
54 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
A40
|
||||
|
||||
Imf Device √ √ √ √ √ √ √
|
||||
or Name/
|
||||
ma MAC
|
||||
tio Machin √ √ √ √ √ √ √ √
|
||||
n e ID
|
||||
|
||||
Model √ √ √ √ √ √ √ √
|
||||
|
||||
Firmwa √ √ √ √ √ √ √ √
|
||||
re
|
||||
Versio
|
||||
n
|
||||
|
||||
Softwa √ √ √ √ √ √ √ √
|
||||
re
|
||||
Inform
|
||||
ation
|
||||
|
||||
Periphe √ √ √ √ √ √ √
|
||||
ral
|
||||
Device
|
||||
|
||||
IP √ √ √ √ √ √ √ √
|
||||
|
||||
Connec √ √ √ √ √ √ √ √
|
||||
tion
|
||||
Status
|
||||
|
||||
Last √ √ √ √ √ √ √ √
|
||||
Report
|
||||
Time
|
||||
|
||||
Accoun √ √ √
|
||||
t
|
||||
Inform
|
||||
ation
|
||||
|
||||
Storage √ √ √ √
|
||||
Usage
|
||||
|
||||
Memor √ √ √ √
|
||||
|
||||
55 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
y
|
||||
Usage
|
||||
|
||||
CPU √ √ √ √
|
||||
Usage
|
||||
|
||||
Ope Reboo √ √ √ √ √ √ √ √
|
||||
rat t
|
||||
ion Reset √ √ √ √ √ √ √
|
||||
to
|
||||
Factor
|
||||
y
|
||||
|
||||
Up Update √ √ √ √ √ √ √ √
|
||||
dat
|
||||
e Firmwa
|
||||
re
|
||||
|
||||
Di One- √ √ √ √ √ √
|
||||
ag Click
|
||||
no Export
|
||||
se Packet √ √ √ √ √
|
||||
Captur
|
||||
e
|
||||
|
||||
Export √ √ √ √ √ √ √
|
||||
Log
|
||||
|
||||
Export √ √ √ √ √
|
||||
Config
|
||||
File
|
||||
|
||||
Config √ √ √ √ √
|
||||
Backu
|
||||
p
|
||||
|
||||
Networ √ √ √ √ √
|
||||
k
|
||||
Detect
|
||||
ion
|
||||
|
||||
|
||||
56 / 91
|
||||
@@ -0,0 +1,691 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 781-800
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 781-800 of 953
|
||||
**Chunk:** 40
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Screen √ √ √ √ √
|
||||
Captur
|
||||
e
|
||||
|
||||
Remote * * √ √
|
||||
Onl
|
||||
Contro y
|
||||
l Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
Dev Teams √
|
||||
ice Config
|
||||
Con uratio
|
||||
fig n
|
||||
|
||||
Displa √ √
|
||||
y
|
||||
|
||||
Camer √ √ * √
|
||||
a
|
||||
|
||||
Power √ √ √
|
||||
Saving
|
||||
|
||||
Netwo √ √ √ √ √
|
||||
rk
|
||||
|
||||
Securit √ √ √ √ √
|
||||
y
|
||||
|
||||
Basic √ √ √ √ √
|
||||
|
||||
Screen √
|
||||
Cast
|
||||
|
||||
|
||||
57 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Sof YRC √
|
||||
war (x.33.9
|
||||
e 5.0 or
|
||||
Con later)
|
||||
fig
|
||||
|
||||
Alarm Al Offline √ √ √ √ √ √ √
|
||||
& ar Periphe √ √ √ √ √
|
||||
Feedba m ral
|
||||
ck offline
|
||||
|
||||
Firmwa √ √ √ √ √
|
||||
re
|
||||
upgrad
|
||||
e
|
||||
failure
|
||||
|
||||
Configu √ √ √ √
|
||||
ration
|
||||
update
|
||||
failure
|
||||
|
||||
Periphe √ √
|
||||
ral
|
||||
firmwa
|
||||
re
|
||||
upgrad
|
||||
e fail
|
||||
|
||||
Wireles √
|
||||
s mic
|
||||
low
|
||||
power
|
||||
|
||||
Sensor √
|
||||
low
|
||||
power
|
||||
|
||||
Sensor √
|
||||
upgrad
|
||||
|
||||
58 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
e
|
||||
failure
|
||||
|
||||
Networ √ √
|
||||
k
|
||||
discon
|
||||
nectio
|
||||
n
|
||||
|
||||
Call * * *
|
||||
failure Onl
|
||||
y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
High * * *
|
||||
CPU Onl
|
||||
usage y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
High * * *
|
||||
memor Onl
|
||||
|
||||
|
||||
59 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
y y
|
||||
usage Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
Low * * *
|
||||
storage Onl
|
||||
space y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
Process * * *
|
||||
Onl
|
||||
abnor y
|
||||
mal Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
|
||||
60 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Device *
|
||||
Driver
|
||||
Except
|
||||
ion
|
||||
|
||||
Fe One- *
|
||||
ed click
|
||||
ba feedba
|
||||
ck ck
|
||||
|
||||
Not Indepe - - - - - - - -
|
||||
ice ndently
|
||||
|
||||
|
||||
configu
|
||||
re
|
||||
alarm
|
||||
notific
|
||||
ations
|
||||
for
|
||||
differen
|
||||
t
|
||||
rooms.
|
||||
|
||||
Configu - - - - - - - -
|
||||
ring
|
||||
Alarm
|
||||
Silence
|
||||
.
|
||||
|
||||
Con Indepe - - - - - - - -
|
||||
fig ndently
|
||||
ura
|
||||
tio configu
|
||||
n re
|
||||
alarm
|
||||
rules
|
||||
for
|
||||
differen
|
||||
|
||||
61 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
t
|
||||
rooms.
|
||||
|
||||
Inspect ran Device √ √ * * * √
|
||||
ion ge Status
|
||||
|
||||
Active √ √ * * * √
|
||||
Alarm
|
||||
|
||||
Periphe √ √ * * * √
|
||||
ral
|
||||
Status
|
||||
|
||||
CPU * * √
|
||||
Usage Onl
|
||||
y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
Memor * * √
|
||||
y Onl
|
||||
Usage y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
|
||||
62 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Storage * * √
|
||||
Space Onl
|
||||
Usage y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A30
|
||||
/
|
||||
A40
|
||||
|
||||
Firmwa √ √ √ √
|
||||
re
|
||||
Versio
|
||||
n
|
||||
|
||||
Applica √ √ √
|
||||
tion
|
||||
Inform
|
||||
ation
|
||||
|
||||
Exe Regular - - - - - - - -
|
||||
cut or
|
||||
ion one-
|
||||
tim time
|
||||
e task
|
||||
|
||||
Digital Con Schedu - - - - - - - -
|
||||
Signage ten le
|
||||
t Room - - - - - - - -
|
||||
Ty info
|
||||
pe
|
||||
Image - - - - - - - -
|
||||
|
||||
Video - - - - - - - -
|
||||
|
||||
Web - - - - - - - -
|
||||
page
|
||||
|
||||
63 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Text - - - - - - - -
|
||||
|
||||
Carous - - - - - - - -
|
||||
el
|
||||
|
||||
Messa - - - - - - - -
|
||||
ge
|
||||
|
||||
Time - - - - - - - -
|
||||
|
||||
Senor - - - - - - - -
|
||||
|
||||
QR - - - - - - - -
|
||||
Co
|
||||
de
|
||||
|
||||
Supported * * *
|
||||
Device Onl
|
||||
y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A40
|
||||
|
||||
Monitor * * *
|
||||
Onl
|
||||
y
|
||||
Mee
|
||||
tin
|
||||
gBa
|
||||
r
|
||||
A10
|
||||
/
|
||||
A4
|
||||
0
|
||||
|
||||
MonitorWall Mon Device - - - - - - - -
|
||||
ito Status
|
||||
|
||||
64 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
rin Model - - - - - - - -
|
||||
g Statisti
|
||||
ran cs
|
||||
ge Active - - - - - - - -
|
||||
Alarms
|
||||
|
||||
Proble - - - - - - - -
|
||||
m
|
||||
Feedba
|
||||
ck
|
||||
Record
|
||||
|
||||
Top 5 - - - - - - - -
|
||||
Active
|
||||
Alarm
|
||||
Types
|
||||
|
||||
New - - - - - - - -
|
||||
Alarms
|
||||
Last 7
|
||||
Days
|
||||
|
||||
System Dat Channe - - - - - - - -
|
||||
Security a l
|
||||
Sec Diagnos
|
||||
uri is
|
||||
ty Assista
|
||||
nce
|
||||
Authori
|
||||
zation.
|
||||
|
||||
Yealink - - - - - - - -
|
||||
Diagnos
|
||||
tic
|
||||
Assista
|
||||
nce
|
||||
Authori
|
||||
zation.
|
||||
|
||||
|
||||
65 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Delete - - - - - - - -
|
||||
the
|
||||
enterpr
|
||||
ise,
|
||||
clear
|
||||
all
|
||||
device
|
||||
data
|
||||
and
|
||||
stop
|
||||
reporti
|
||||
ng
|
||||
Device
|
||||
data.
|
||||
|
||||
Log Suppor - - - - - - - -
|
||||
in t single
|
||||
Ma sign-
|
||||
na on
|
||||
ge with
|
||||
me third-
|
||||
nt party
|
||||
system
|
||||
s.
|
||||
|
||||
Suppor
|
||||
t login
|
||||
whiteli
|
||||
st.
|
||||
|
||||
Passwo - - - - - - - -
|
||||
rd
|
||||
Change
|
||||
|
||||
|
||||
Remind
|
||||
er.
|
||||
|
||||
MFA - - - - - - - -
|
||||
|
||||
66 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
login
|
||||
verific
|
||||
ation.
|
||||
|
||||
Sub Suppor - - - - - - - -
|
||||
t RBAC
|
||||
Acc
|
||||
oun
|
||||
ts
|
||||
|
||||
Ope All - - - - - - - -
|
||||
rat operati
|
||||
ion ons
|
||||
Lo will be
|
||||
gs record
|
||||
ed and
|
||||
review
|
||||
ed.
|
||||
|
||||
|
||||
|
||||
|
||||
67 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Remote Control
|
||||
Introduction
|
||||
You can remotely operate the touch screen of the MVC device and troubleshoot
|
||||
problems through remote control. Due to data security, YMCS only accesses data
|
||||
on the touch screen and does not store it during remote control.
|
||||
Prerequisites
|
||||
You have assigned the remote control license to the meeting room.
|
||||
Do one of the following:
|
||||
If your enterprise is located in EU region, please refer to the network requirements of
|
||||
remote control under EU region and open the relevant domain name and port;
|
||||
If your enterprise is located in US region, please refer to the network requirements of
|
||||
remote control under US region and open the relevant domain name and port.
|
||||
If your enterprise is located in AU region, please refer to the network requirements of
|
||||
remote control under AU region and open the relevant domain name and port.
|
||||
If your enterprise is located in UAE region, please refer to the network requirements of
|
||||
remote control under UAE region and open the relevant domain name and port.
|
||||
You can simultaneously control multiple devices in one room, currently supporting up to 2
|
||||
devices.
|
||||
The device status needs to be online.
|
||||
The remote control feature is enabled.
|
||||
|
||||
|
||||
|
||||
|
||||
68 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
The device owner allows you to remote control. For more information, see device
|
||||
authorization status-general issues.
|
||||
|
||||
Procedure
|
||||
Remote Control in a Room
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms > Rooms.
|
||||
3. Click the desired room name to go to the details page.
|
||||
4. Click Remote Control.
|
||||
5. Click Remote Control on the right side of the desired device; (optional) if the device has
|
||||
|
||||
69 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
peripheral devices, you can choose to control only the device or control the device and its
|
||||
peripheral devices.
|
||||
|
||||
💡 NOTE
|
||||
You can simultaneously control 2 devices in one room.
|
||||
|
||||
1. Wait for the response from the device to start the remote control, and the remote control
|
||||
will end automatically when its duration is more than 45 minutes.
|
||||
|
||||
💡 NOTE
|
||||
For Android devices, you need to enter the local administrator password.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Please refer to the user's guide of each device to operate the device and
|
||||
troubleshoot the problem.
|
||||
|
||||
💡 TIP
|
||||
Click End in the upper right corner of the interface to end control; in the left
|
||||
navigation bar, click End Control below the device to end control of the
|
||||
device.
|
||||
If you control multiple devices, you can drag and drop windows to change
|
||||
the display ratio of each screen.
|
||||
|
||||
70 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Hover the mouse over
|
||||
|
||||
|
||||
|
||||
|
||||
to view the device’s current bandwidth, delay, packet loss and other
|
||||
network information.
|
||||
|
||||
|
||||
|
||||
|
||||
Remote Control Specific Device
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms > Devices.
|
||||
3. Click the desired device name to go to the details page.
|
||||
4. Click Remote Control.
|
||||
5. Click Remote Control on the right side of the desired device; (optional) if the device has
|
||||
peripheral devices, you can choose to control only the device or control the device and its
|
||||
peripheral devices.
|
||||
|
||||
💡 NOTE
|
||||
You can simultaneously control 2 devices in one room.
|
||||
|
||||
6. Wait for the response from the device to start the remote control, and the remote control
|
||||
will end automatically when its duration is more than 45 minutes.
|
||||
|
||||
|
||||
|
||||
71 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
For Android devices, you need to enter the local administrator password.
|
||||
|
||||
|
||||
|
||||
|
||||
7. Please refer to the user's guide of each device to operate the device and
|
||||
troubleshoot the problem.
|
||||
|
||||
💡 TIP
|
||||
Click End in the upper right corner of the interface to end control; in the left
|
||||
navigation bar, click End Control below the device to end control of the
|
||||
device.
|
||||
If you control multiple devices, you can drag and drop windows to change
|
||||
the display ratio of each screen.
|
||||
Hover the mouse over
|
||||
|
||||
|
||||
|
||||
|
||||
to view the device’s current bandwidth, delay, packet loss and other
|
||||
network information.
|
||||
|
||||
|
||||
|
||||
72 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
73 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Configuration
|
||||
Introduction
|
||||
You can edit the CFG parameters with the text editor and choose configuration
|
||||
options with the GUI editor. After pushing the configuration to the device, the
|
||||
configuration you've set will take effect on the device.
|
||||
|
||||
💡 TIP
|
||||
You can refer to Administrator Guide of each device to understand the
|
||||
functions and corresponding configurations of display, audio and video,
|
||||
conference platforms, and network settings.
|
||||
|
||||
Set Parameters via GUI Editor
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
If you need to configure a specific device, go to the Device Details page and enter the
|
||||
Configuration Management interface, or click Configure on the right side of the desired
|
||||
device in the device list.
|
||||
If you need to configure devices of the same model in any space, enter Configuration
|
||||
page and then click Configuration on the right side of the device.
|
||||
74 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 TIP
|
||||
Click View on the Configuration status of each device to check the current config.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click GUI Editor.
|
||||
4. From the left navigation menu, select the module you need to configure. On the right side,
|
||||
set the desired parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
|
||||
|
||||
75 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
You can click Enable All, Disable All, or Reset to perform the batch operation
|
||||
quickly.
|
||||
If the device is offline, it will pick up the updated configuration when it comes
|
||||
back online.
|
||||
The green bubble on the right side of the configuration item displays the number
|
||||
of configurations that have been selected.
|
||||
|
||||
5. Click Save.
|
||||
6. Choose the way to synchronize with Sub-sites.
|
||||
Only synchronize the content of this modification: For the sub-space, only update the
|
||||
modified/added configuration of this time and keep the original content of other
|
||||
configurations.
|
||||
Synchronize all configuration items: For the sub-space, reset them to the current
|
||||
configuration of this level.
|
||||
7. Choose the coverage strategy.
|
||||
Overwrite lower-level area configuration content: Based on the effective scope of the
|
||||
configuration, it will be fully applied to subordinate sites.
|
||||
Do not overwrite the configuration content of the subordinate region: For already
|
||||
configured items at the subordinate level, the parameter values will not be overwritten
|
||||
by this save.
|
||||
8. Click Confirm.
|
||||
|
||||
Set Parameters via Text Editor
|
||||
Prerequisites
|
||||
MVC/TVC/ZVC do not support Text Editor.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
76 / 91
|
||||
@@ -0,0 +1,414 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 801-820
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 801-820 of 953
|
||||
**Chunk:** 41
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
If you need to configure a specific device, go to the Device Details page and enter the
|
||||
Configuration Management interface, or click Configure on the right side of the desired
|
||||
device in the device list.
|
||||
If you need to configure devices of the same model in any space, enter Configuration
|
||||
page and then click Configuration on the right side of the device.
|
||||
|
||||
💡 TIP
|
||||
Click View on the Configuration status of each device to check the current config.
|
||||
|
||||
|
||||
|
||||
|
||||
77 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
3. Click Text Editor.
|
||||
4. Edit parameters in the text editor. You can set the parameter template by editing the
|
||||
configuration lines. Edit in the format of key=value, with each parameter on a separate line.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 TIP
|
||||
If you already have configuration files, you can set the parameters via uploading
|
||||
configuration file.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Save.
|
||||
6. Choose the way to synchronize with Sub-sites.
|
||||
Only synchronize the content of this modification: For the sub-space, only update the
|
||||
|
||||
78 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
modified/added configuration of this time and keep the original content of other
|
||||
configurations.
|
||||
Synchronize all configuration items: For the sub-space, reset them to the current
|
||||
configuration of this level.
|
||||
7. Select whether to override the strategy.
|
||||
Overwrite lower-level area configuration content: Based on the effective scope of the
|
||||
configuration, it will be fully applied to subordinate sites.
|
||||
Do not overwrite the configuration content of the subordinate region: For already
|
||||
configured items at the subordinate level, the parameter values will not be overwritten
|
||||
by this save.
|
||||
8. Click Confirm.
|
||||
|
||||
For MVC devices, manage Teams configuration
|
||||
Supports setting Teams configuration for MVC series devices.
|
||||
|
||||
💡 NOTE
|
||||
To configure Teams settings using text, please refer to theofficial
|
||||
Microsoft documentation 。
|
||||
|
||||
1. Log in to YMCS.
|
||||
2. Click Device Management > Device List.
|
||||
3. Click Configuration on the right side of the MVC device.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Configure related content
|
||||
|
||||
Teams
|
||||
Configuration methods support graphical configuration/upload XML file configurations.
|
||||
79 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Graphical configuration mode supports selecting single-screen/dual-screen display.
|
||||
Teams themes support selecting Teams preset themes/custom themes.
|
||||
|
||||
|
||||
|
||||
|
||||
Custom themes need to add wallpapers in Resource Management > Other Resources.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The image size should be exactly 3840 x 1080.
|
||||
|
||||
Click Push, select Immediately or Schedule Task.
|
||||
|
||||
|
||||
|
||||
|
||||
80 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Supports configuration: BIOS, Windows, network settings, Teams
|
||||
configuration, Teams account and password.
|
||||
BIOS, Windows, network settings, Teams configuration, Teams
|
||||
password support batch configuration.
|
||||
|
||||
|
||||
|
||||
Software Config
|
||||
Procedure
|
||||
|
||||
81 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Sign in to YMCS.
|
||||
2. Click Workspace > Configuration > Software Config.
|
||||
3. Click Configuration on the right side of the software.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Manage the configuration according to your needs.
|
||||
5. Click Save and choose the way of synchronizing to Sub-sites. The configuration is created
|
||||
successfully.
|
||||
|
||||
|
||||
|
||||
|
||||
82 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6.
|
||||
|
||||
💡 TIP
|
||||
• Offline and pending devices will take effect after they go online.
|
||||
• Only x.33.95.0 and later versions of YRC support this feature.
|
||||
|
||||
|
||||
|
||||
|
||||
83 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
RPS Overview
|
||||
Introduction
|
||||
The RPS overview gives you a global view of the total number of enterprise RPS
|
||||
devices, unassigned devices, and total number of servers.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click RPS > Overview and do one of the following:
|
||||
Click Devices to view the total number of RPS devices.
|
||||
Click Unassigned Devices to view all the unassigned devices.
|
||||
Click Servers to view the total number of servers.
|
||||
|
||||
|
||||
|
||||
|
||||
84 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage RPS Devices
|
||||
Add Devices
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click RPS > Device > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit device-related information.
|
||||
MAC: Enter the MAC address of the device. MAC must and can only contain 12 letters or
|
||||
numbers. The length is limited to 12-17 characters, the characters that can be entered
|
||||
include 0-9, A-z, "-", ":", for example, 00-15-65-1a-2b-3c, 00:15:65:1a:2b:3c,
|
||||
0015651a2B3c.
|
||||
Machine ID: Enter the Machine ID of the device. The Machine ID is the SN corresponding
|
||||
to the body sticker or the Machine ID displayed in the device status information.
|
||||
Server Name: Choose a server.
|
||||
Unique Server URL: Enter a server URL as the redirection address.
|
||||
Username: Enter the username that can access the unique server.
|
||||
Password: Enter the password that can access the unique server.
|
||||
Description: Enter the description.
|
||||
|
||||
|
||||
|
||||
85 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
i. If you select an added server and enter a unique server URL, YMCS PRS service
|
||||
performs the redirection according to the unique URL you entered. Otherwise,
|
||||
YMCS RPS service performs the redirection according to the URL of the added
|
||||
server.
|
||||
ii. If you enter the correct MAC and Machine ID, it can be verified that the device
|
||||
belongs to you. After manually adding/importing the device, it will
|
||||
automatically be removed from other companies. A maximum of 20 records
|
||||
can be deleted per day.
|
||||
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
86 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
87 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Manage Devices
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click RPS > Device and do one of the following:
|
||||
|
||||
|
||||
|
||||
|
||||
Click Edit to edit the device information.
|
||||
Select devices and click Migrate to migrate the devices to another server.
|
||||
Select devices, click Sync to enable the DM service for the devices, and select the
|
||||
site to which the device belongs. After that, you can use the device management
|
||||
feature to manage RPS devices.
|
||||
|
||||
💡 NOTE
|
||||
If you want to use this Sync feature, please contact Yealink technical support to enable it.
|
||||
|
||||
|
||||
Select devices and click Reset Connection to bind the device to the RPS again.
|
||||
Select devices and click Delete.
|
||||
Click Batch Reset to bind the device to the RPS by importing a batch of existing
|
||||
enterprise devices.
|
||||
Click Import to quickly add a batch of devices
|
||||
Click Export to export a batch of device information for easy retrieval of devices, backup
|
||||
device information, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
88 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Release Occupied Device
|
||||
Introduction
|
||||
For specific reasons (such as switching service providers), RPS devices may be
|
||||
occupied by other enterprise platforms. YMCS provides a corresponding
|
||||
solution that allows users to remove the device from other enterprise platforms
|
||||
by entering the correct MAC address and Machine ID, thereby restoring its
|
||||
normal usage status.
|
||||
If you need to release the occupied phone device, please refer to: Phone Devices.
|
||||
|
||||
💡 NOTE
|
||||
Enterprises with any of the permissions (including: Workspace
|
||||
Management/Device Management/RPS) enhance the ability to release
|
||||
occupied RPS devices.
|
||||
The permissions for enterprises are set by the channel. For more
|
||||
information, please refer to: Permission.
|
||||
|
||||
|
||||
|
||||
89 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click RPS > Device.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Release Occupied Device.
|
||||
|
||||
💡 TIP
|
||||
For an occupied device, if you correctly fill in its MAC and Machine ID when adding the
|
||||
device, the device can also be successfully released from occupation and added.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Enter the MAC and Machine ID of the device in the pop-up window, and click Release .
|
||||
|
||||
90 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
Limitation on the number of released occupied devices: 20 devices per day.
|
||||
|
||||
|
||||
|
||||
|
||||
91 / 91
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage RPS Server
|
||||
Add Servers
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
2. Click RPS > Server > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Set related parameters.
|
||||
|
||||
Server Name: Set a name for the server.
|
||||
Server URL: Enter a server URL as the redirection address.
|
||||
Username: Enter the username that can access the redirection server.
|
||||
Password: Enter the password that can access the redirection server.
|
||||
Trusted Certificates File: Support importing certificates trusted by the
|
||||
device.
|
||||
Server Certificates: Support importing certificates for devices to connect to
|
||||
the server. When the custom certificate feature is enabled, the device
|
||||
updates to the new certificate.
|
||||
Custom Certificates: Select whether to enable the custom certificate.
|
||||
|
||||
|
||||
1 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
|
||||
If the device needs to verify the server and requires a custom
|
||||
certificate, upload the trusted certificate file.
|
||||
If the server needs to verify the phone and requires a custom
|
||||
certificate, upload the server certificate file.
|
||||
If the server needs the phone to send a custom server certificate,
|
||||
turn on the custom certificate feature; the custom certificate is
|
||||
turned off by default, and the phone sends the default certificate
|
||||
for verification.
|
||||
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
2 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Servers
|
||||
3 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
2. Click RPS Server, and do one of the following:
|
||||
|
||||
Click Edit or any server name to edit server information.
|
||||
Select servers and click Delete, then the binding status of the
|
||||
corresponding device will become unbound after deletion.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
RPS PIN Guide
|
||||
Introduction
|
||||
To enhance the security of RPS service for legacy devices, Yealink will no longer
|
||||
provide RPS support for certain older devices. To continue using the RPS
|
||||
service, these devices must be upgraded to the specified firmware version and
|
||||
used in conjunction with the RPS PIN feature.
|
||||
(For unsupported versions and recommended upgrade versions, please refer to:
|
||||
https://support.yealink.com/en/portal/knowledge/show?id=687f7b3706b3cf2066d84dea)
|
||||
|
||||
Procedure
|
||||
1. You can view the RPS PIN associated with each MAC in the platform's RPS device list. Please
|
||||
provide the corresponding RPS PIN to your end customers so they can enter it on their
|
||||
devices to complete the RPS process.
|
||||
(1) For devices upgraded to the recommended firmware version, the RPS PIN only needs to
|
||||
be entered once. Future access to RPS will not require re-entry.
|
||||
(2) For devices already upgraded to a supported version but not the recommended version,
|
||||
RPS access is allowed via PIN entry; however, the PIN must be re-entered each time RPS is
|
||||
triggered.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
If the platform does not display an RPS PIN for a device, it means the
|
||||
|
||||
5 / 108
|
||||
@@ -0,0 +1,460 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 821-840
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 821-840 of 953
|
||||
**Chunk:** 42
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
device has a built-in authentication mechanism, and no manual PIN
|
||||
entry is required.
|
||||
|
||||
1. When the RPS service is triggered on the device side, a prompt will appear on the screen.
|
||||
The user can then enter the RPS PIN obtained from the platform to complete the RPS
|
||||
process.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
If the PIN is entered incorrectly 5 times, the device will skip the RPS
|
||||
process.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Enterprise Information
|
||||
View the Enterprise Information
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Enterprise Information.
|
||||
|
||||
|
||||
|
||||
|
||||
Authorize Enterprise Management to a Channel
|
||||
If this channel creates the enterprise, authorization will be granted immediately.
|
||||
Otherwise, you will need to wait for the channel to approve or reject your
|
||||
authorization.
|
||||
After successful authorization, the channel side can sign in to YMCS directly and
|
||||
manage your enterprise devices.
|
||||
1. Click Authorization on the right side of Enterprise Authorization.
|
||||
2. Enter the authorization code obtained from a channel and click Authorization.
|
||||
3. Read and agree the《YMCS Diagnose Support Assistance Privacy Statement》.
|
||||
4. If the company is created through this channel, the authorization will be successful
|
||||
immediately; if the company is not created through this channel, you need to wait for the
|
||||
channel to agree/reject your authorization.
|
||||
5. After successful authorization, the channel end can directly log in and manage your
|
||||
company.
|
||||
|
||||
7 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Un-authorize Enterprise Management to a Channel
|
||||
After authorization is canceled, the channel cannot sign in to YMCS directly and
|
||||
manage your enterprise devices.
|
||||
1. Click Cancel Authorization on the right side of Enterprise Authorization.
|
||||
2. Confirm your action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
|
||||
Yealink Diagnosis Assistance
|
||||
You can authorize diagnosis assistance to Yealink. After successful authorization,
|
||||
|
||||
8 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Yealink can enter the device diagnosis and details interface within the
|
||||
authorized time.
|
||||
1. Click Authorization on the right side of Yealink Diagnosis Assistance.
|
||||
|
||||
💡 NOTE
|
||||
Confirmation of authorization means that you have read and agree to .
|
||||
|
||||
|
||||
|
||||
|
||||
2. When enabled, it supports adding multiple authorization rules; when
|
||||
disabled, deleting all current rules will no longer take effect.
|
||||
|
||||
💡 NOTE
|
||||
Please contact Yealink technical support and add authorization rules for
|
||||
the corresponding time period after confirming acceptance of assistance.
|
||||
|
||||
1. Click Add authorization to add authorization rules.
|
||||
Authorization name: Describe the issue you are experiencing, a maximum of 128
|
||||
characters.
|
||||
Devices: Select the device.
|
||||
Effective time: Set the effective time.
|
||||
|
||||
|
||||
|
||||
9 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Transfer Main Administrator
|
||||
1. Click Transfer on the right side of Main Administrator.
|
||||
2. Select Sub Accounts as the transferee, and click Confirm.
|
||||
|
||||
|
||||
|
||||
|
||||
Enterprise Deletion
|
||||
|
||||
10 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 NOTE
|
||||
After logging out, the enterprise account and related data will be
|
||||
automatically deleted after 72 hours.
|
||||
Support cancel enterprise deletion within 72 hours.
|
||||
Enterprise deletion is irreversible, please operate with caution.
|
||||
|
||||
1. Click Delete on the right side of Enterprise Deletion.
|
||||
2. Enter the enterprise email and click Send in the pop-up window.
|
||||
3. Enter the verification code from the received email.
|
||||
4. Click Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Enterprise Information
|
||||
Enterprise Name: View the enterprise name.
|
||||
Enterprise ID: View or copy the enterprise ID. When connecting devices to YMCS via the
|
||||
auto-provisioning server, you can enter the enterprise ID in the CFG file so the devices can
|
||||
be added to your enterprise directly.
|
||||
Country/Region: View the country/location that the enterprise locates.
|
||||
Time Zone: View the time zone.
|
||||
Node: View the data center used for storing the enterprise data and information.
|
||||
AutoP Address: View or copy the AutoP address. When connecting devices to YMCS via
|
||||
|
||||
|
||||
11 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
DHCP server, you can enter the AutoP address in the CFG file so the devices can be added
|
||||
to your enterprise directly.
|
||||
DM Server Address: View or copy the DM Server address. When connecting devices to
|
||||
YMCS via the auto-provisioning server, you can enter the DM Server address in the CFG file
|
||||
so the devices can be added to your enterprise directly.
|
||||
Contact: Edit the contact name.
|
||||
Phone Number: Edit the phone number of the contact.
|
||||
|
||||
|
||||
|
||||
|
||||
12 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Order Management
|
||||
Introduction
|
||||
Order management can be used to view the order and license information of the
|
||||
current enterprise after the service is activated, including the total number of
|
||||
equipment supported for management in the equipment management order
|
||||
and the allocation of advanced conference room licenses. If the order is within
|
||||
the validity period, the superposition of all orders shall be held. If the service is
|
||||
about to expire, you need to purchase the service from the superior channels to
|
||||
continue the service. When an order is terminated, canceled, or expired, you can
|
||||
receive notifications on YMCS that the status of the order has changed. To obtain
|
||||
the service price and open the license, please contact Yealink Technical Support.
|
||||
Go to Order Management
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Order Management.
|
||||
|
||||
|
||||
|
||||
|
||||
View Device-Professional License
|
||||
Introduction
|
||||
Order Type, the maximum number of devices supported for management, the
|
||||
number of devices currently added, and the order expiration date are displayed
|
||||
|
||||
13 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
in the device management order. As shown in the figure, the maximum number
|
||||
of devices supported and managed by the enterprise is 6000; the number of
|
||||
devices currently added is 5100.
|
||||
|
||||
💡 TIP
|
||||
If your enterprise activates device management for the first time, you will
|
||||
receive a complimentary device management order for 1000 devices, and
|
||||
it will be permanently free.
|
||||
|
||||
|
||||
|
||||
|
||||
Procedure
|
||||
1. In the order list, click the Details on the right side of the device-professional order to view
|
||||
the order details such as order time, service duration and validity period.
|
||||
|
||||
|
||||
|
||||
|
||||
14 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
View Room-Professional License
|
||||
Introduction
|
||||
Room-Professional licenses show the order type, total number of licenses
|
||||
owned by the enterprise, the number of licenses assigned, and when the
|
||||
licenses expire. You can assign the licenses to the designated meeting room,
|
||||
and you can use the remote control feature on the room devices in the
|
||||
corresponding meeting room. As shown in the figure, the total number of
|
||||
professional room licenses owned by the enterprise is 50, and the number of
|
||||
rooms with a professional room license is 13. The total number of digital signage
|
||||
licenses owned by the enterprise is 14, and the number of devices with a digital
|
||||
signage license is 7
|
||||
|
||||
|
||||
|
||||
|
||||
Procedure
|
||||
1. In the order list, click Details on the right side of the desired order.
|
||||
|
||||
|
||||
|
||||
|
||||
15 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click Order Details or Assign License to view the order details, such as order time, service
|
||||
duration, and validity period, as well as information such as allocated meeting rooms and
|
||||
valid license status.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Validity starts when the license is first assigned to the meeting room.
|
||||
|
||||
|
||||
Assign Professional Rooms License
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click WorkSpace > Rooms.
|
||||
3. Click Assign License to the right of the order type for Professional Rooms License.
|
||||
|
||||
|
||||
|
||||
16 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Confirm your action in the pop-up window to complete the assignment. You can see the
|
||||
assigned license under the column of License.
|
||||
|
||||
|
||||
|
||||
|
||||
17 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Only one premium room license can be assigned to a meeting room.
|
||||
For meeting rooms that have been assigned a license, you can continue
|
||||
to use the Premium Meeting Room features for 14 days after the license
|
||||
expires. To ensure the continued use of services and features, it is
|
||||
recommended that you make a service purchase within these 14 days.
|
||||
|
||||
Assign Digital Signage License
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
18 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click WorkSpace > Rooms.
|
||||
3. Click Assign License to the right of the order type for Digital Signage License.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Confirm your action in the pop-up window to complete the assignment. You can see the
|
||||
assigned license under the column of License.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Digital signage licenses can only be assigned to devices that have
|
||||
already installed the digital signage app.
|
||||
MeetingDisplay devices that successfully report by 11:59:59 PM on
|
||||
December 13, 2025, will get a free one-year digital signage license.
|
||||
Digital signage tasks can only be published to the device that has been
|
||||
|
||||
|
||||
19 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
assigned a digital signage license.
|
||||
|
||||
|
||||
|
||||
|
||||
20 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Settings
|
||||
Device Settings
|
||||
Site Management
|
||||
Add Sites
|
||||
|
||||
Introduction
|
||||
You can add sites according to the specific IP range, enterprise organization, or
|
||||
location. This makes device management under the same site more accessible
|
||||
and more efficient.
|
||||
|
||||
Prerequisites
|
||||
The default site named after your company name is added when the system is
|
||||
initialized and cannot be deleted.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Settings > Devices > Sites.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Add or select a site from the site list and click
|
||||
|
||||
|
||||
|
||||
21 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Add.
|
||||
|
||||
|
||||
|
||||
|
||||
22 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit site information.
|
||||
5. Optional: you can enable Auto Assign Device by IP Rule. If enabled, devices that match
|
||||
the site IP will be automatically assigned to the corresponding site, while devices that do
|
||||
not match the site IP will be automatically moved to the root site. This can help you
|
||||
perform unified management of devices under the same IP address.
|
||||
|
||||
💡 NOTE
|
||||
You can add 0.0. 0.0 in the Public IP field, which means all IP addresses are
|
||||
acceptable.
|
||||
You can move phone and room devices into the Manual Site Setting list. Devices in
|
||||
the list WON'T be automatically removed from their current sites (including sites
|
||||
with Auto Assign Device by IP Rule enabled). Site changes require manual resetting.
|
||||
For more details, see Manual Site Setting List for phone devices or Manual Site Setting
|
||||
List for room devices.
|
||||
|
||||
6. Click Save. Once the site is added, you can move devices to that site for management.
|
||||
|
||||
💡 NOTE
|
||||
The priority (the devices automatically connected to the site) in descending order is
|
||||
the site IP setting, the site setting in the Common.cfg file, and the site setting in
|
||||
importing a batch of devices.
|
||||
When a device falls within the IP range of both a sub-site and a superior site, the
|
||||
device will be directed to the sub-site as a priority.
|
||||
If two sites are at the same level and Site A is configured with both public and private
|
||||
IP addresses while Site B is configured with only the public IP address, the device will
|
||||
be directed to Site A as a priority.
|
||||
|
||||
|
||||
|
||||
Import Sites
|
||||
|
||||
23 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Introduction
|
||||
If you want to quickly add multiple sites or modify site information in batch, you
|
||||
can import sites in batch. You need to download the template, add multiple
|
||||
sites, or export sites, edit the site information, and then import the file into
|
||||
YMCS.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Settings > Devices > Sites.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Import.
|
||||
4. Fill out the form according to the template and click Upload on the site management page
|
||||
to upload it to complete the import.
|
||||
|
||||
|
||||
Manage Sites
|
||||
|
||||
Go to the Site Management Page
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Sign in to YMCS.
|
||||
3. Click System > Settings > Devices > Sites.
|
||||
|
||||
|
||||
|
||||
|
||||
24 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Rearrange the Sites
|
||||
Introduction
|
||||
You can reorder sites of the same level by dragging and dropping them. By
|
||||
default, the sites are sorted based on the order in which they were added.
|
||||
Procedure
|
||||
1. On the site management page, select a site from the site list and drag it to adjust the order.
|
||||
|
||||
💡 NOTE
|
||||
Dragging and dropping can only change the order of sites of the same level and cannot
|
||||
modify the parent site of a particular site.
|
||||
|
||||
|
||||
Import Sites
|
||||
Introduction
|
||||
For more information, see import sites.
|
||||
|
||||
Export Sites
|
||||
Introduction
|
||||
You can export the information of the sites to edit them and then import the
|
||||
edited information back into the platform, enabling quick management of
|
||||
multiple sites.
|
||||
|
||||
25 / 108
|
||||
@@ -0,0 +1,390 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 841-860
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 841-860 of 953
|
||||
**Chunk:** 43
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. On the site management page, click Export and click
|
||||
|
||||
|
||||
|
||||
|
||||
in the bottom-left corner to check the file locally.
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Delete Sites
|
||||
Procedure
|
||||
1. On the site management page, do one of the following:
|
||||
Select a desired site from the site list and click
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
Select a desired site from the site list and click Delete.
|
||||
|
||||
|
||||
27 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Site Information
|
||||
Procedure
|
||||
1. In the site list, select a site and do one of the following:
|
||||
Click Edit or click
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit to edit the site information.
|
||||
View the site name, the site ID, the description and other information.
|
||||
Clcik
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the site ID to copy the site ID. When you use auto-provisioning server
|
||||
to connect devices to YMCS, you can paste the site in the CFG file so the device can be
|
||||
directly assigned to this site.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to regenerate a site ID. The old one will become invalid.
|
||||
|
||||
|
||||
Alarm Mute
|
||||
|
||||
Introduction
|
||||
You can enable the alarm mute feature for phone and room devices. Once
|
||||
enabled, the platform will refrain from triggering new alarms during the
|
||||
specified time period.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Device > Alarm Mute > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
31 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Set the parameters.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
32 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
RPS Settings
|
||||
Introduction
|
||||
You can enable the AutoSync feature, so newly added RPS devices will be
|
||||
automatically synchronized to the device list under the Device Management
|
||||
module, and then you can manage the RPS devices.
|
||||
|
||||
Prerequisites
|
||||
Please contact Yealink technical support to activate this feature.
|
||||
If you disable the AutoSync feature globally, all devices will not be synced.
|
||||
If you enable the AutoSync feature globally, devices without an assigned server will be
|
||||
automatically synced to the root site of YMCS. Devices assigned to a server will
|
||||
automatically be synced to the site with the same name as the server.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Settings > RPS.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select Enable from drop-down menu of Initial Value of Server AutoSync and enable
|
||||
AutoSync.
|
||||
|
||||
|
||||
|
||||
|
||||
33 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. (Optional): Enable Automatic Site Creation. If enabled, a site with the same server name
|
||||
will be created when you create a new server.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Details.
|
||||
|
||||
|
||||
|
||||
|
||||
34 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
If you select Disable from the drop-down menu of Initial Value of Server AutoSync, you
|
||||
need to manually enable the Auto Sync feature for the desired server.
|
||||
Click to enable AutoSync.
|
||||
Select servers and click Enable AutoSync.
|
||||
|
||||
|
||||
|
||||
|
||||
If you do not enable Automatic Site Creation, you need to manually create a site with
|
||||
the same server name.
|
||||
Click Create Now.
|
||||
Select servers and click Create Site with the Same Name.
|
||||
|
||||
|
||||
|
||||
35 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
You can select servers and click Disable AutoSync, then the server will not sync devices
|
||||
from the RPS devices list under the RPS module to the device list under the Device
|
||||
Management module.
|
||||
You can select servers and click Site for Device-sync, then devices bound with the
|
||||
server will be assigned to the corresponding site.
|
||||
|
||||
|
||||
|
||||
|
||||
36 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Security
|
||||
IP Whitelist
|
||||
Introduction
|
||||
Support editing login whitelist, only IP addresses within the whitelist can log in
|
||||
to the enterprise management platform, which further enhances the enterprise
|
||||
security.
|
||||
|
||||
💡 NOTE
|
||||
Whether the channel end can access the enterprise management
|
||||
platform is not restricted by the login whitelist.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System Settings > Security > Login Mangement.
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
37 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to add and edit the login whitelist, you can add a maximum of 20 IP addresses.
|
||||
|
||||
|
||||
|
||||
|
||||
38 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click
|
||||
|
||||
|
||||
|
||||
|
||||
39 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to enable IP Whitelist.
|
||||
|
||||
|
||||
|
||||
|
||||
Password Change Reminder
|
||||
Introduction
|
||||
You can set a password change reminder and the frequency of the reminder. If
|
||||
an administrator's password exceeds the set frequency, they will receive an
|
||||
email reminder to change their password.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
|
||||
|
||||
40 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click System Settings > Security > Login Mangement.
|
||||
3. In the Password Change Reminder section, click
|
||||
|
||||
|
||||
|
||||
|
||||
to enable it.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the reminder frequency and save.
|
||||
|
||||
💡 NOTE
|
||||
The maximum setting is 365 days.
|
||||
|
||||
|
||||
|
||||
|
||||
41 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Login Settings
|
||||
You can configure the web timeout logout time; if no action is taken within the
|
||||
configured time, it will automatically log out.
|
||||
1. Log in to YMCS.
|
||||
2. Click System > Security > Login Management.
|
||||
|
||||
In the Timeout Duration area, click to customize the
|
||||
duration.
|
||||
RPS Whitelist
|
||||
Introduction
|
||||
You can add trusted IP addresses to the allowlist, which eliminates the need for
|
||||
manual SN verification on devices when connecting them to RPS from those IP
|
||||
addresses.
|
||||
|
||||
Add an IP Address to RPS Whitelist
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Security > RPS Whitelist > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
42 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Enter the IP address and description and click Save.
|
||||
4. Confirm your action in the pop-up window.
|
||||
|
||||
Manage RPS Whitelist
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Security > RPS Whitelist and do one of the following:
|
||||
Click Edit on the right side of the desired IP to edit the IP information.
|
||||
|
||||
|
||||
|
||||
|
||||
Click Delete on the right side of the desired IP or select IP addresses and click Delete to
|
||||
|
||||
|
||||
43 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
remove the IP from the allow list.
|
||||
|
||||
|
||||
|
||||
|
||||
Intercepted Records
|
||||
Introduction
|
||||
When you connect devices to YMCS RPS, the IP addresses of devices that failed
|
||||
to get authenticated will be recorded to the intercept records.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Security > Intercept Records.
|
||||
3. Do one of the following:
|
||||
Select records and click Add to Allowlist. This IP address will be trusted and added to
|
||||
the allowlist, which eliminates the need for manual SN verification on devices when
|
||||
connecting them to RPS from those IP addresses.
|
||||
Select records and click Reset Connection. The IP connection status will be reset.
|
||||
|
||||
|
||||
|
||||
|
||||
44 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Intergration
|
||||
Integrate O365
|
||||
Introduction
|
||||
By configuring integration, you can synchronize Microsoft O365 calendar data to
|
||||
YMCS.
|
||||
|
||||
Configure the application on O365
|
||||
1. Log in with your account and add an application.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Set the corresponding permissions for the application.
|
||||
|
||||
|
||||
|
||||
|
||||
45 / 108
|
||||
@@ -0,0 +1,486 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 861-880
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 861-880 of 953
|
||||
**Chunk:** 44
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3.Set the APP Secret.
|
||||
|
||||
|
||||
|
||||
|
||||
4.Obtain the Client ID (APP ID) and Tenant ID.
|
||||
|
||||
|
||||
|
||||
|
||||
46 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Configure on YMCS
|
||||
1. Create an Azure application
|
||||
1. Enter "https://portal.azure.com" in the address bar of your computer's browser to access
|
||||
the Azure portal.
|
||||
2. Click Azure Active Directory > Manage > App registrations and select New registration.
|
||||
3. Edit account information and save.
|
||||
Name: Edit the name users see when logging in using the App.
|
||||
Supported account types: Select which types of account logins the app can be used for.
|
||||
Redirect URI (optional): When the authentication is passed, Microsoft will send the Token
|
||||
to this address.
|
||||
4. After completing the application creation, obtain the Application (client) ID/Secret of the
|
||||
application.
|
||||
|
||||
2. Obtain access token
|
||||
Using the OAuth 2.0 authorization flow, obtain an access token to access the
|
||||
user's calendar data through the Microsoft Graph API. For more information,
|
||||
see: Microsoft Identity Platform and OAuth 2.0 Authorization Code Flow and Get
|
||||
access on behalf of user.
|
||||
3. Perform integrated configuration on YMCS
|
||||
1. Log in to YMCS.
|
||||
2. Click System > Integration > Third-Party Service.
|
||||
3. In the O365 module, click Edit.
|
||||
|
||||
|
||||
47 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Fill in the information you obtained in step 1 and click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
5. If the verification is successful, you can click Sync Now in the pop-up window to
|
||||
synchronize calendar resources immediately Account and calendar data, or you can click
|
||||
|
||||
|
||||
|
||||
|
||||
48 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to enable this feature.
|
||||
|
||||
💡 NOTE
|
||||
Calendar resource accounts are synchronized once every 24 hours, and
|
||||
calendar data is synchronized in real time.
|
||||
|
||||
|
||||
|
||||
|
||||
Service Now
|
||||
Step 1 Apply for Client ID and Client Secret information
|
||||
|
||||
Procedure
|
||||
1. Search for System Oauth in ALL and select Application Registry to enter the application
|
||||
page.
|
||||
|
||||
|
||||
|
||||
|
||||
49 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
2. Enter the page and click New to create the Client ID and Client Secret information provided
|
||||
to the YMCS platform for synchronizing data.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Select Create an OAuth API endpoint for external clients.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Create Client ID and Client Secret.
|
||||
Fill in the Name, Client ID, and Client Secret, then click Submit.
|
||||
|
||||
|
||||
|
||||
|
||||
50 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
Remember the Client ID and Client Secret information here.
|
||||
|
||||
|
||||
💡 TIP
|
||||
Client Secret length should be 32 to 128 characters.
|
||||
|
||||
Step 2 Create Alarm Sync User
|
||||
|
||||
Procedure
|
||||
1. Search User Administration in ALL and select Users to enter users management page.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click New to create user information for the YMCS platform to synchronize data.
|
||||
|
||||
|
||||
51 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Fill in User ID, First name, Last name, and click Save to create a user.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
The user created here will be the caller of the incident work order record.
|
||||
|
||||
4. Click Set Password > Generate > Save Password to set the password.
|
||||
|
||||
|
||||
|
||||
|
||||
52 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
After generation, you can click
|
||||
|
||||
|
||||
|
||||
|
||||
53 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to copy the currently generated password.
|
||||
After saving, you need to reset your password by default. Here you can
|
||||
choose to use the account login to change the account password, you can
|
||||
also choose to uncheck the Password need reset checkbox to update.
|
||||
|
||||
5. Add role.
|
||||
Click Edit on the Roles tab, search for incident_manager, click
|
||||
|
||||
|
||||
|
||||
|
||||
54 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Save.
|
||||
|
||||
|
||||
|
||||
|
||||
55 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click Save.
|
||||
Step 3 Configuration on YMCS
|
||||
|
||||
Procedure
|
||||
1. Sign in YMCS.
|
||||
|
||||
2. Click System > Integration > Third-Party Service.
|
||||
|
||||
3. In the Servicenow module, click Edit.
|
||||
|
||||
|
||||
|
||||
|
||||
56 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Fill in Servicenow information.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Save.
|
||||
|
||||
6. Click
|
||||
|
||||
|
||||
|
||||
|
||||
57 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
to enable this feature.
|
||||
|
||||
|
||||
|
||||
|
||||
Step 4 Configure ServiceNow Callback
|
||||
|
||||
Introduction
|
||||
After configuring the callback, ServiceNow Incident closure and cancellation
|
||||
actions will be synchronized back to the alarm status through YMCS's OpenAPI.
|
||||
|
||||
Get OpenAPI Access Key
|
||||
1. Sign in YMCS.
|
||||
2. Click System > Integration > API.
|
||||
|
||||
58 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Configure Callback Scripts
|
||||
1. Search Business Rules in All, and click the one in the System Definition to enter.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click New.
|
||||
|
||||
|
||||
|
||||
|
||||
59 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Set the information.
|
||||
Name
|
||||
Table: Incident.
|
||||
Select Advanced.
|
||||
When to run:
|
||||
When: Select After.
|
||||
Filter Conditions: Set the State field to changes.
|
||||
|
||||
|
||||
|
||||
|
||||
4. configure script.
|
||||
Configure the callback script in the Advanced tab.
|
||||
|
||||
|
||||
|
||||
|
||||
60 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click Submit.
|
||||
|
||||
💡 NOTE
|
||||
The API address, accessKeyId, and accessKeySecret here need to
|
||||
configure the Access Key information of your YMCS enterprise account.
|
||||
|
||||
|
||||
|
||||
|
||||
(function executeRule(current, previous /*null when async*/ ) {
|
||||
|
||||
|
||||
// openapi address
|
||||
var endpoint = 'your openapi address';
|
||||
// Replace with your access key information
|
||||
|
||||
61 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
accessKeyId='your access key id';
|
||||
accessKeySecret='your access key secret';
|
||||
|
||||
|
||||
changeYMCSAlarmStatus(endpoint, accessKeyId, accessKeySecret, current, previous);
|
||||
})(current, previous);
|
||||
|
||||
|
||||
function changeYMCSAlarmStatus(endpoint, accessKeyId, accessKeySecre, current,
|
||||
previous){
|
||||
// Only handles update status and the status is closed or cancelled
|
||||
if (!(current && previous) || !(current.state == 7 || current.state == 8)) {
|
||||
return;
|
||||
}
|
||||
// Check whether the configuration is configured
|
||||
if(!isVaildConfiguration(endpoint, accessKeyId, accessKeySecret)){
|
||||
return;
|
||||
}
|
||||
// No processing will be performed if the status has not changed.
|
||||
if (current.state == previous.state) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
var token = getTokenCache(endpoint, accessKeyId, accessKeySecret);
|
||||
if(!token) {
|
||||
return;
|
||||
}
|
||||
// Only handles closing and cancelling state sync
|
||||
// Closed ==> Resolved
|
||||
// Canceled ==> Ignored
|
||||
if (current.state == 7) {
|
||||
synchronousIncidentStatus(endpoint, token, current.correlation_id, 2);
|
||||
} else if (current.state == 8) {
|
||||
synchronousIncidentStatus(endpoint, token, current.correlation_id, 3);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
62 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
// Check whether the configuration is configured
|
||||
function isVaildConfiguration(endpoint, accessKeyId, accessKeySecret){
|
||||
if(!endpoint ||!accessKeyId || !accessKeySecret
|
||||
|| endpoint == '' ||accessKeyId == '' || accessKeySecret == ''){
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
// Synchronize the alarm status of YMCS platform
|
||||
function synchronousIncidentStatus(endpoint, token, alarmId, status){
|
||||
gs.info('[YMCS] synchronous incident status start');
|
||||
if(!token || !alarmId || alarmId == '') {
|
||||
return;
|
||||
}
|
||||
var alarmOpenApi= endpoint + '/v2/dm/alarm/changeStatus';
|
||||
var authorization = token['token_type'] + ' ' + token['access_token'];
|
||||
var headers = {
|
||||
Authorization: authorization,
|
||||
timestamp: new Date().getTime(),
|
||||
nonce: getNonce()
|
||||
};
|
||||
var requestBody = {
|
||||
ids: [alarmId + ''],
|
||||
status: status + ''
|
||||
};
|
||||
var response = request('PATCH', alarmOpenApi, requestBody, headers);
|
||||
if(!response) {
|
||||
gs.warn('[YMCS] Synchronous incident status response is empty');
|
||||
return;
|
||||
}
|
||||
var responseObject = JSON.parse(response);
|
||||
if(isError(responseObject)) {
|
||||
|
||||
|
||||
63 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
gs.warn('[YMCS] Synchronous incident failure, response: ' + JSON.stringify(response));
|
||||
} else {
|
||||
gs.info('[YMCS] synchronous incident status end, responseObject: '+
|
||||
JSON.stringify(response));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Get authorization token
|
||||
function getTokenCache(endpoint, accessKeyId, accessKeySecret){
|
||||
var TOKEN_TYPE_KEY = 'YMCS_CACHE_TOKEN';
|
||||
var ACCESS_TOKEN_KEY = 'YMCS_CACHE_ACCESS_TOKEN';
|
||||
var EXPIRY_KEY = 'YMCS_CACHE_EXPIRY';
|
||||
var tokenType = gs.getProperty(TOKEN_TYPE_KEY);
|
||||
var accessToken = gs.getProperty(ACCESS_TOKEN_KEY);
|
||||
var expiry = gs.getProperty(EXPIRY_KEY);
|
||||
if (accessToken && expiry) {
|
||||
var now = new Date().getTime();
|
||||
if (expiry > now) {
|
||||
return {
|
||||
'token_type': tokenType,
|
||||
'access_token': accessToken
|
||||
};
|
||||
}
|
||||
}
|
||||
// If there is no valid token, get a new one
|
||||
var newToken = getToken(endpoint, accessKeyId, accessKeySecret);
|
||||
if(isError(newToken)) {
|
||||
gs.warn('[YMCS] Get token error:'+ JSON.stringify(newToken));
|
||||
return undefined;
|
||||
}
|
||||
// Cache the new token to system properties as cache
|
||||
gs.setProperty(TOKEN_TYPE_KEY, newToken['token_type']);
|
||||
gs.setProperty(ACCESS_TOKEN_KEY, newToken['access_token']);
|
||||
var expiryTimestamp = new Date().getTime() + (newToken['expires_in'] * 1000) - 10000;
|
||||
|
||||
|
||||
64 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
gs.setProperty(EXPIRY_KEY, expiryTimestamp);
|
||||
return newToken;
|
||||
}
|
||||
|
||||
|
||||
// Get authorization token
|
||||
function getToken(endpoint, accessKeyId, accessKeySecret){
|
||||
var tokenApi= endpoint + '/v2/token';
|
||||
var requestBody = {
|
||||
grant_type: 'client_credentials'
|
||||
};
|
||||
var headers = {
|
||||
Authorization: getBasicAuth(accessKeyId, accessKeySecret),
|
||||
timestamp: new Date().getTime(),
|
||||
nonce: getNonce()
|
||||
};
|
||||
var response = request('POST', tokenApi, requestBody, headers);
|
||||
if(!response) {
|
||||
gs.warn('[YMCS] Get token response is empty');
|
||||
return undefined;
|
||||
}
|
||||
var tokenObject = JSON.parse(response);
|
||||
if (isError(tokenObject)) {
|
||||
gs.warn('[YMCS] Failed to get token, response:' + JSON.stringify(tokenObject));
|
||||
return undefined;
|
||||
}
|
||||
return tokenObject;
|
||||
}
|
||||
|
||||
|
||||
// clear token cache
|
||||
function clearTokenCache(){
|
||||
gs.setProperty('YMCS_CACHE_TOKEN', '');
|
||||
gs.setProperty('YMCS_CACHE_ACCESS_TOKEN', '');
|
||||
gs.setProperty('YMCS_CACHE_EXPIRY', '');
|
||||
}
|
||||
|
||||
|
||||
65 / 108
|
||||
@@ -0,0 +1,469 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 881-900
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 881-900 of 953
|
||||
**Chunk:** 45
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
// Request Data
|
||||
function request(method, endpoint, requestBody, headers){
|
||||
// Create a GlideHTTPRequest object
|
||||
var httpRequest = new sn_ws.RESTMessageV2();
|
||||
// Set the endpoint for REST messages
|
||||
httpRequest.setEndpoint(endpoint);
|
||||
// Set the HTTP method to POST
|
||||
httpRequest.setHttpMethod(method);
|
||||
// Set the HTTP headers
|
||||
if (headers) {
|
||||
for (var key in headers) {
|
||||
if (headers.hasOwnProperty(key)) {
|
||||
httpRequest.setRequestHeader(key, headers[key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
// Send a request and get a response
|
||||
httpRequest.setRequestHeader("Content-Type", "application/json");
|
||||
httpRequest.setRequestBody(JSON.stringify(requestBody));
|
||||
var httpResponse = httpRequest.execute();
|
||||
// Get the response body (body)
|
||||
return httpResponse.getBody();
|
||||
}
|
||||
|
||||
|
||||
// Build authentication information
|
||||
function getBasicAuth(accessKeyId, accessKeySecret) {
|
||||
var credentials = accessKeyId + ':' + accessKeySecret;
|
||||
var base64Credentials = GlideStringUtil.base64Encode(credentials);
|
||||
return 'Basic ' + base64Credentials;
|
||||
}
|
||||
|
||||
|
||||
// generateUUID
|
||||
function getNonce() {
|
||||
|
||||
|
||||
66 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
|
||||
var r = Math.random() * 16 | 0,
|
||||
v = c == 'x' ? r : (r & 0x3 | 0x8);
|
||||
return v.toString(16);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
// is error
|
||||
function isError(responseObject){
|
||||
if (responseObject && !responseObject.hasOwnProperty('error')) {
|
||||
return false;
|
||||
}
|
||||
if (responseObject && (!responseObject['error'] || responseObject['error'] == '')) {
|
||||
return false;
|
||||
}
|
||||
clearTokenCache();
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Single Sign-On
|
||||
Step 1 Configure Microsoft Azure AD Login Method
|
||||
|
||||
Procedure
|
||||
1. Log in to the Azure admin portal.
|
||||
2. Click
|
||||
|
||||
|
||||
|
||||
|
||||
67 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Azure Active Directory in the top-left corner.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Enterprise applications in the left navigation bar.
|
||||
|
||||
|
||||
|
||||
|
||||
68 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
4. Click All applications > New application.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click Create your own application. Enter the application name and check Register an
|
||||
application to integrate with Azure AD (App you’re deploying) and click Create.
|
||||
|
||||
|
||||
|
||||
|
||||
69 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
6. Check Accounts in this organizational directory only (wmroomtest only - Single
|
||||
tenant) to support trial for users in the current tenant directory and click Register.
|
||||
|
||||
|
||||
|
||||
|
||||
7. Go back to the Azure Active Directory home page, click App registrations, find and click the
|
||||
application you just create.
|
||||
|
||||
|
||||
|
||||
|
||||
70 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
8. Go to the application details page. The Application (client) ID is the Client ID and the
|
||||
directory (tenant) is the Tenant ID.
|
||||
|
||||
|
||||
|
||||
|
||||
9. Click Authentication > Add a platform in the left navigation bar and select Web.
|
||||
|
||||
|
||||
|
||||
|
||||
71 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
10. Enter the login address in the Redirect URIs field, the logout address in the Front-
|
||||
channel logout URL field, and select the check box of ID tokens (used for implicit and
|
||||
hybrid flows) and click Configure. Please enter the following login and logout addresses
|
||||
according to your site.
|
||||
|
||||
|
||||
|
||||
|
||||
11. The configuration is complete. You can perform further SSO configuration in the YMCS
|
||||
platform.
|
||||
|
||||
EU Login address https://eu.ymcs.yealink.com/manager/front/auth/
|
||||
region signin-oidc
|
||||
|
||||
Logout https://eu.ymcs.yealink.com/manager/front/auth/
|
||||
address logout
|
||||
|
||||
72 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
US Login address https://us.ymcs.yealink.com/manager/front/auth/
|
||||
region signin-oidc
|
||||
|
||||
Logout https://us.ymcs.yealink.com/manager/front/auth/
|
||||
address logout
|
||||
|
||||
AU Login address https://au.ymcs.yealink.com/manager/front/auth/
|
||||
region signin-oidc
|
||||
|
||||
Logout https://au.ymcs.yealink.com/manager/front/auth/
|
||||
address logout
|
||||
UAE Login address https://uae.ymcs.yealink.com/manager/front/auth/signin-
|
||||
region oidc
|
||||
|
||||
Logout address https://uae.ymcs.yealink.com/manager/front/auth/logout
|
||||
|
||||
Step 2 Enable and Configure SSO
|
||||
|
||||
Introduction
|
||||
After enabling single sign-on and creating third-party administrator accounts,
|
||||
you can use these accounts to sign in to the YMCS platform with the account and
|
||||
password of the third-party platform (only Microsoft accounts are supported),
|
||||
improving login efficiency and avoiding security risks.
|
||||
|
||||
Procedure
|
||||
Enable SSO
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Integration > Single Sign-On.
|
||||
|
||||
|
||||
|
||||
|
||||
73 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click the toggle beside Single Sign-On to enable it.
|
||||
4. Select an authentication platform (currently, only Microsoft Azure AD is supported).
|
||||
5. Refer to the Microsoft AD login configuration method and enter the Client ID of Microsoft
|
||||
Azure AD as well as the Tenant ID to configure the authentication platform.
|
||||
6. Click Save.
|
||||
|
||||
Create a Sub Account with SSO Feature
|
||||
Please refer to add sub accounts to create a sub account with SSO feature.
|
||||
Once configured, this sub account can log in to the YMCS platform using SSO.
|
||||
Step 3 Sign In via SSO
|
||||
|
||||
Introduction
|
||||
You can use your Microsoft account to easily log in to the YMCS platform,
|
||||
effectively improving login efficiency and avoiding some of the security risks.
|
||||
|
||||
Prerequisites
|
||||
Your enterprise has configure Microsoft Azure AD login method and enabled SSO.
|
||||
The enterprise administrator has created a third-party administrator account for you.
|
||||
|
||||
Procedure
|
||||
1. For the first login, click the login address in the email or enter the login address in the
|
||||
browser address bar.
|
||||
|
||||
💡 TIP
|
||||
|
||||
74 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
You can use the global address (https://ymcs.yealink.com/manager/
|
||||
login) to sign in, and YMCS will automatically detect and redirect you to
|
||||
your region.
|
||||
|
||||
2. Optional: Switch the language in the top-right corner.
|
||||
3. Click SSO.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Enter the third-party account and click Continue.
|
||||
|
||||
|
||||
|
||||
|
||||
5. On the Microsoft login authentication page, enter your Microsoft account and password.
|
||||
After finishing the verification, you can log in to YMCS.
|
||||
|
||||
|
||||
|
||||
|
||||
75 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
API
|
||||
Introduction
|
||||
You can view the enterprise's API domain name on the API service interface, as
|
||||
well as the AccessKey ID and AccessKey Secret used for identity verification in
|
||||
API requests.
|
||||
|
||||
💡 NOTE
|
||||
Only super administrators can see the API interface.
|
||||
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click System > Integration > API.
|
||||
|
||||
|
||||
|
||||
|
||||
76 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
Click Edit to Reacquire or Delete the authentication information. The old authentication
|
||||
information will become invalid immediately.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to view the corresponding information.
|
||||
|
||||
|
||||
77 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
to copy the corresponding information.
|
||||
|
||||
|
||||
|
||||
|
||||
78 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Log Management
|
||||
Introduction
|
||||
Any operations performed by the administrator, the sub-administrator, or the
|
||||
superior channel on the YMCS are recorded as the operation logs. You can view
|
||||
these operation records through log management to obtain details such as the
|
||||
operation target, operator, and operation time.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Logs.
|
||||
|
||||
|
||||
|
||||
|
||||
3. You can find specific operation records by selecting a start time or searching for an
|
||||
operator/IP.
|
||||
|
||||
|
||||
|
||||
|
||||
79 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Sub Accounts and Their
|
||||
Permission
|
||||
Sub Accounts
|
||||
Add Sub Accounts
|
||||
|
||||
Introduction
|
||||
You can add sub accounts for your organization, which can log in to YMCS and
|
||||
have specific operational permission granted by you for relevant features.
|
||||
Only the main account (the registered email address used when the enterprise
|
||||
was created) and super administrators have the authority to manage sub-
|
||||
accounts and associate roles with them.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Sub Accounts > Sub Accounts > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the sub-account-related information.
|
||||
Account Type: Select the account type as Ordinary/External.
|
||||
Ordinary: The sub-account is created in YMCS.
|
||||
|
||||
|
||||
80 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
External: You can use the Microsoft account credentials to sign in to YMCS via
|
||||
SSO.
|
||||
|
||||
💡 NOTE
|
||||
You need to configure SSO before creating a third-party account.
|
||||
|
||||
|
||||
Email: Enter the email address of this account.
|
||||
Contact: Enter the contact name.
|
||||
Phone Number: Edit the phone number of the contact.
|
||||
Role: Select Administrator.
|
||||
Login Protection: Enable or disable the login protection feature.
|
||||
Description: Enter a description.
|
||||
4. Click OK. The sub account is created. At the same time, the sub account will receive an
|
||||
email containing the login address, the username, the password and other information.
|
||||
|
||||
|
||||
|
||||
|
||||
81 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
82 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
Manage Sub Accounts
|
||||
Introduction
|
||||
You can add sub accounts for your organization, which can log in to YMCS and
|
||||
have specific operational permission for relevant features.
|
||||
|
||||
Go to the Sub Account List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Sub Accounts > Sub Accounts.
|
||||
|
||||
|
||||
|
||||
|
||||
Edit Sub Account
|
||||
Procedure
|
||||
1. In the sub account list, click Edit on the right side of the desired account to edit the related
|
||||
information.
|
||||
|
||||
Enable/Disable Login Protection
|
||||
Procedure
|
||||
1. In the sub account list, click and select
|
||||
|
||||
|
||||
|
||||
|
||||
83 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select Enable Login Protection/Disable Login Protection.
|
||||
|
||||
Enable/Disable Sub Account
|
||||
Introduction
|
||||
The sub account is activated by default after it is created. You can enable or
|
||||
disable the sub account. When the account status changes, the sub account will
|
||||
get notifications via email.
|
||||
Procedure
|
||||
1. In the sub account list, click and select
|
||||
|
||||
|
||||
|
||||
|
||||
84 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select Enable Account/Disable Account.
|
||||
2. If the account is disabled, the account cannot sign in to YMCS.
|
||||
|
||||
Reset Password
|
||||
Password reset can deal with password leakage and manage personnel changes
|
||||
to enhance security.
|
||||
Procedure
|
||||
1. In the sub account list, click and select
|
||||
|
||||
|
||||
|
||||
|
||||
85 / 108
|
||||
@@ -0,0 +1,464 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 901-920
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 901-920 of 953
|
||||
**Chunk:** 46
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select Reset Password.
|
||||
2. Confirm your action in the pop-up window.
|
||||
3. An email notification will be sent to the sub-administrator after the password is reset.
|
||||
|
||||
Delete Sub Accounts
|
||||
Procedure
|
||||
1. In the sub account list, click and select
|
||||
|
||||
|
||||
|
||||
|
||||
86 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
and select Delete.
|
||||
2. Confirm your action in the pop-up window.
|
||||
|
||||
|
||||
|
||||
Roles
|
||||
Add Roles
|
||||
|
||||
Introduction
|
||||
The default role and its permission are described below:
|
||||
|
||||
Nam Description
|
||||
e
|
||||
|
||||
Super Have all the function permission under the device management, RPS
|
||||
management, workspace management, and system management
|
||||
admi modules and can view all the site data.
|
||||
|
||||
|
||||
87 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
n
|
||||
|
||||
DM Have all the device management permission under the device
|
||||
admi management and system management modules and can view all the
|
||||
n site data.
|
||||
|
||||
RPS Have all the RPS management permission under the device
|
||||
admi management and system management modules and can view all the
|
||||
n server data.
|
||||
|
||||
WM Have all the workspace management permission under the
|
||||
admi workspace management and system management modules.
|
||||
n
|
||||
|
||||
Empt Only the permission to log in.
|
||||
y
|
||||
permi
|
||||
ssion
|
||||
|
||||
In addition to the default roles, you can add other roles and assign the
|
||||
corresponding permission to the role.
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Sub Accounts > Role.
|
||||
|
||||
|
||||
|
||||
|
||||
88 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Do one of the following:
|
||||
Select a group from the group list on the left panel and click Add. You can also click Add
|
||||
Group if you do not want to specify a group.
|
||||
Click
|
||||
|
||||
|
||||
|
||||
on the right side of the group and click Add Role.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Edit the role information and click Save.
|
||||
Role Name: Edit the role name.
|
||||
Group: Select a belonging group for this role for future management.
|
||||
|
||||
89 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Description: Enter a description.
|
||||
Role Permission: Assign permission to the role, including Device Management, RPS
|
||||
Management, WorkSpace Management, and System. Multiple selections are supported.
|
||||
See the following detailed description.
|
||||
|
||||
|
||||
|
||||
|
||||
Device Management
|
||||
Device Permission
|
||||
Select All or select Specify Range and click Edit to select the desired sites. After
|
||||
selection, the role can see the data of the selected sites.
|
||||
|
||||
💡 NOTE
|
||||
Click Edit and specify the site. If you check the parent site, the role will
|
||||
have all data permission for the parent site and its sub-sites.
|
||||
Click Edit and specify the site. If you check all sub-sites under the
|
||||
parent site, the role will have data permissions for all sub-sites but not
|
||||
for the parent site itself. You can select up to 10 sites.
|
||||
It is applicable to modules other than resource management under
|
||||
operation permission and function permission.
|
||||
|
||||
|
||||
|
||||
|
||||
90 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Resource Permission
|
||||
Select All or select Specify Range and click Edit to select the desired sites. After
|
||||
selection, the role can see the data of the selected sites.
|
||||
|
||||
💡 NOTE
|
||||
Click Edit and specify the site. If you check the parent site, the role will
|
||||
have all data permission for the parent site and its sub-sites.
|
||||
Click Edit and specify the site. If you check all sub-sites under the
|
||||
parent site, the role will have data permissions for all sub-sites but not
|
||||
for the parent site itself. You can select up to 10 sites.
|
||||
It is applicable to resource management modules under function
|
||||
permission.
|
||||
|
||||
|
||||
|
||||
|
||||
Operation Permission
|
||||
Select the device type and select the corresponding operational permission for
|
||||
this role. Multiple selections are allowed.
|
||||
|
||||
|
||||
91 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Function Permission
|
||||
Assign relevant operational permissions for this role based on the menu
|
||||
|
||||
|
||||
|
||||
|
||||
(categorized according to the functional modules in the left-side navigation bar).
|
||||
92 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Multiple selections are allowed.
|
||||
Read only: You can only view the data without any operation permission.
|
||||
Read & Write: You can view the data with all the operation permissions.
|
||||
Invisible: This part is unavailable and invisible to you.
|
||||
|
||||
|
||||
|
||||
|
||||
RPS Management
|
||||
Data Permission
|
||||
Select All or select Specify Range to select the desired servers. After selection,
|
||||
the role can see the data of the selected servers.
|
||||
|
||||
|
||||
|
||||
|
||||
💡 NOTE
|
||||
If you choose All, the role will have data permissions for all servers and
|
||||
|
||||
|
||||
93 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
their devices without a limit on the number of servers.
|
||||
If you choose Specify Range, the role will have data permissions for
|
||||
the specified servers and their devices. In this case, you can select a
|
||||
maximum of 100 servers.
|
||||
|
||||
Function Permission
|
||||
Assign relevant operational permissions for this role based on the menu
|
||||
|
||||
|
||||
|
||||
|
||||
(categorized according to the functional modules in the left-side navigation bar).
|
||||
Multiple selections are allowed.
|
||||
Read only: You can only view the data without any operation permission.
|
||||
Read & Write: You can view the data with all the operation permission.
|
||||
Invisible: This part is unavailable and invisible to you.
|
||||
|
||||
WorkSpace Management
|
||||
|
||||
94 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Function permission
|
||||
Assign relevant operational permissions for this role based on the menu
|
||||
|
||||
|
||||
|
||||
|
||||
(categorized according to the functional modules in the left-side navigation bar).
|
||||
Multiple selections are allowed.
|
||||
Read only: You can only view the data without any operation permission.
|
||||
Read & Write: You can view the data with all the operation permission.
|
||||
Invisible: This part is unavailable and invisible to you.
|
||||
|
||||
System
|
||||
|
||||
💡 NOTE
|
||||
Roles are granted system management permissions by default. Therefore,
|
||||
when you associate a sub-administrator with a role, they will have
|
||||
|
||||
95 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
permissions for all data within the enterprise. Please use caution when
|
||||
assigning these permissions.
|
||||
Function Permission
|
||||
Assign relevant operational permissions for this role based on the menu
|
||||
|
||||
|
||||
|
||||
|
||||
(categorized according to the functional modules in the left-side navigation
|
||||
bar). Multiple selections are allowed.
|
||||
Read only: You can only view the data without any operation permission.
|
||||
Read & Write: You can view the data with all the operation permission.
|
||||
Invisible: This part is unavailable and invisible to you.
|
||||
|
||||
|
||||
|
||||
Manage Roles
|
||||
Go to the Role List
|
||||
|
||||
|
||||
96 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Sub Accounts > Role.
|
||||
|
||||
|
||||
|
||||
|
||||
Add Groups
|
||||
Introduction
|
||||
You can add groups and manage the roles by group.
|
||||
Procedure
|
||||
1. In the role list, click Add Group.
|
||||
2. Enter the group name and click Confirm.
|
||||
3. After adding a group, you can find the group from the group list.
|
||||
|
||||
Manage Roles by Group
|
||||
Introduction
|
||||
You can organize and manage administrators within the enterprise by grouping
|
||||
them. Each role can only belong to one group.
|
||||
Procedure
|
||||
1. In the role list, click the desired group.
|
||||
2. Do one of the following:
|
||||
Check the corresponding role information within this group.
|
||||
|
||||
|
||||
|
||||
97 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
on the right side of the group to edit groups, add roles to the group, and delete groups.
|
||||
|
||||
View Sub Accounts Associated with a Role
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
2. Click the number under the Associated accounts.
|
||||
3. View the sub accounts associated with this role. Those sub accounts have all the
|
||||
permissions assigned to this role.
|
||||
|
||||
Assign a Role to a Sub Account
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
2. Do one of the following:
|
||||
In the sub account list, click Edit on the right side of the desired sub account and select a
|
||||
role.
|
||||
|
||||
|
||||
|
||||
|
||||
98 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
In the role list, click Add on the right side of the desired role and select a role.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the sub account information. For more information, see add sub account.
|
||||
|
||||
Edit Role Permission
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
2. Click Permission.
|
||||
3. Edit the role permission and click Save.
|
||||
|
||||
NOTE
|
||||
|
||||
99 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
💡 You cannot edit the permission of the default role (super admin, DM admin, RPS admin, WM
|
||||
admin, and empty permission).
|
||||
|
||||
|
||||
Manage Roles
|
||||
|
||||
Go to the Role List
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Sub Accounts > Role.
|
||||
|
||||
|
||||
|
||||
|
||||
Add Groups
|
||||
Introduction
|
||||
You can add groups and manage the roles by group.
|
||||
Procedure
|
||||
1. In the role list, click Add Group.
|
||||
2. Enter the group name and click Confirm.
|
||||
3. After adding a group, you can find the group from the group list.
|
||||
|
||||
Manage Roles by Group
|
||||
Introduction
|
||||
You can organize and manage administrators within the enterprise by grouping
|
||||
them. Each role can only belong to one group.
|
||||
|
||||
100 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. In the role list, click the desired group.
|
||||
2. Do one of the following:
|
||||
Check the corresponding role information within this group.
|
||||
|
||||
|
||||
|
||||
|
||||
Click
|
||||
|
||||
|
||||
|
||||
|
||||
101 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the group to edit groups, add roles to the group, and delete groups.
|
||||
|
||||
View Sub Accounts Associated with a Role
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
2. Click the number under the Associated accounts.
|
||||
3. View the sub accounts associated with this role. Those sub accounts have all the
|
||||
permissions assigned to this role.
|
||||
|
||||
Assign a Role to a Sub Account
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
|
||||
102 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Do one of the following:
|
||||
In the sub account list, click Edit on the right side of the desired sub account and select a
|
||||
role.
|
||||
|
||||
|
||||
|
||||
|
||||
In the role list, click Add on the right side of the desired role and select a role.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the sub account information. For more information, see add sub account.
|
||||
|
||||
Edit Role Permission
|
||||
Procedure
|
||||
1. In the role list, click the desired role.
|
||||
|
||||
|
||||
103 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click Permission.
|
||||
3. Edit the role permission and click Save.
|
||||
|
||||
💡 NOTE
|
||||
You cannot edit the permission of the default role (super admin, DM admin, RPS admin, WM
|
||||
admin, and empty permission).
|
||||
|
||||
|
||||
|
||||
|
||||
104 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Account Settings
|
||||
View and Edit Administrator Account Information
|
||||
Introduction
|
||||
As an enterprise administrator, you can view the account information. To ensure
|
||||
account security, we recommend that you change the password regularly.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Do one of the following:
|
||||
Click the account avatar icon in the bottom-left corner and click Account Information.
|
||||
|
||||
|
||||
|
||||
|
||||
Click System > Account Information.
|
||||
|
||||
|
||||
|
||||
|
||||
105 / 108
|
||||
@@ -0,0 +1,389 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 921-940
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 921-940 of 953
|
||||
**Chunk:** 47
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. View the account information, such as email or role.
|
||||
|
||||
Edit the Login Password
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the Password field, click Edit.
|
||||
4. Enter the current password, the new password, and the confirm password.
|
||||
|
||||
💡 NOTE
|
||||
|
||||
|
||||
106 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Password requirements:
|
||||
|
||||
|
||||
The password must be between 8 and 32 characters.
|
||||
The password must contain at least three of the following: numbers, lowercase and
|
||||
uppercase letters, and special characters.
|
||||
The password must only contain numbers, lowercase and uppercase letters, and special
|
||||
characters (excluding space).
|
||||
Password cannot contain account.
|
||||
The password cannot contain continuous or repeated more than 3 times characters.
|
||||
5. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Login Protection
|
||||
For more information, see login protection.
|
||||
Trusted Devices
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
3. In the Trusted Devices section, click View.
|
||||
4. In the pop-up window, you can view all the devices where you have previously checked the
|
||||
"Skip re-verification within 30 days" option during login verification. You can remove
|
||||
devices, and the next time you log in with those devices, you will need to undergo MFA
|
||||
verification again.
|
||||
|
||||
Default Login Platform
|
||||
107 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Log in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
3. In the Default Login Platform section, click Edit.
|
||||
|
||||
|
||||
|
||||
|
||||
108 / 108
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Login Protection
|
||||
Configure Login Verification (Super Administrator)
|
||||
Introduction
|
||||
For single-factor authentication, the passwords are easily cracked by brute
|
||||
force. To solve that, YMCS supports multi-factor authentication (MFA), requiring
|
||||
users to pass two authentications before they can sign in to YMCS. By enabling
|
||||
login protection, you will need to authenticate through both password and
|
||||
dynamic verification code to gain authorization and sign in to YMCS.
|
||||
|
||||
Email Verification
|
||||
Enable Email Verification
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
3. In the Login Protection field, click Edit.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Select Email, enter the dynamic code in the mail you received, and click OK.
|
||||
|
||||
|
||||
|
||||
1 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Sign In with Email Verification
|
||||
After enabling it, users will receive a verification email after entering their
|
||||
account and password to log in. Enter the verification code in the corresponding
|
||||
area to complete the login process.
|
||||
Procedure
|
||||
1. After clicking Sign In, enter the verification code received in your email in the
|
||||
corresponding area.
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will not need to
|
||||
undergo verification when logging in to this account using the same device within 30 days.
|
||||
2. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
MFA Verification
|
||||
Enable MFA Verification
|
||||
|
||||
2 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
3. In the Login Protection field, click Edit.
|
||||
4. Select Virtual MFA Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Hover over Check how to get the dynamic code and do the following to get the dynamic
|
||||
code.
|
||||
6. Install and open Google Authenticator on the mobile side, and click Get started.
|
||||
7. Sign in to a Google account.
|
||||
|
||||
💡 TIP
|
||||
After you sign in to a Google account, you can back up the verification codes to your Google
|
||||
account for easy retrieval. To avoid situations where verification codes cannot be retrieved
|
||||
after Google Authenticator is uninstalled or data is cleared, it is recommended that you do
|
||||
not skip the login steps.
|
||||
|
||||
|
||||
8. Do one of the following:
|
||||
Select Scan a QR code in Google Authenticator and scan the QR code in the pop-up
|
||||
window on the YMCS portal.
|
||||
|
||||
|
||||
|
||||
|
||||
3 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Select Enter a setup key on Google Authenticator, then enter the YMCS account and the
|
||||
key displayed in the pop-up window, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
4 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
9. The dynamic code is displayed in Google Authenticator.
|
||||
10. Enter the dynamic code into YMCS and click OK.
|
||||
|
||||
Sign In with MFA Verification
|
||||
After enabling it, users will be required to enter the dynamic code obtained from
|
||||
Google Authenticator after entering their account and password to complete the
|
||||
login process.
|
||||
Procedure
|
||||
1. After clicking Sign In, enter the dynamic code into the corresponding area of YMCS.
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will not need to
|
||||
undergo verification when logging in to this account using the same device within 30 days.
|
||||
|
||||
5 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
2. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Configure Login Verification (Sub Account)
|
||||
Prerequisite
|
||||
The super administrator has enabled login protection for you. Otherwise, you
|
||||
cannot enable the login protection.
|
||||
|
||||
Perform Login Verification
|
||||
Introduction
|
||||
After the super administrator has enabled the login protection for you, you need
|
||||
to choose the login verification for the initial login. The selected verification
|
||||
method will serve as your subsequent login protection method.
|
||||
|
||||
|
||||
|
||||
|
||||
6 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Perform Email Verification
|
||||
If you select email verification during the initial login, it will serve as your
|
||||
subsequent login protection method.
|
||||
Procedure
|
||||
1. Select Email, enter the dynamic code in the mail you received.
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will not need to
|
||||
undergo verification when logging in to this account using the same device within 30 days.
|
||||
2. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
Perform Virtual MFA Verification
|
||||
Procedure
|
||||
|
||||
7 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
1. Select Virtual MFA Device.
|
||||
2. Download and open Google Authenticator on your phone and click Get started.
|
||||
3. Sign in to a Google account.
|
||||
|
||||
💡 TIP
|
||||
After you sign in to a Google account, you can back up the verification codes to your Google
|
||||
account for easy retrieval. To avoid situations where verification codes cannot be retrieved
|
||||
after Google Authenticator is uninstalled or data is cleared, it is recommended that you do
|
||||
not skip the login steps.
|
||||
|
||||
|
||||
4. Do one of the following:
|
||||
Select Scan a QR code in Google Authenticator and scan the QR code in the pop-up
|
||||
window on the YMCS portal.
|
||||
|
||||
|
||||
|
||||
|
||||
8 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
Select Enter a setup key on Google Authenticator, then enter the YMCS account and the
|
||||
key displayed in the pop-up window, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
5. The dynamic code will be displayed in Google Authenticator.
|
||||
6. Enter the dynamic code into the corresponding area of YMCS.
|
||||
(Optional) Check the "Skip re-verification within 30 days" option, and you will not need to
|
||||
undergo verification when logging in to this account using the same device within 30 days.
|
||||
7. Click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
9 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Change Login Protection Methods
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click System > Account Information.
|
||||
3. In the Login Protection field, click Edit.
|
||||
4. Do one of the following to select the desired login protection method:
|
||||
Select Email, enter the dynamic code in the mail you received, and click OK.
|
||||
|
||||
|
||||
i. Select Virtual MFA Device.
|
||||
ii. Install and open Google Authenticator on the mobile side, and click Get started.
|
||||
|
||||
|
||||
|
||||
|
||||
10 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
11 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
iii. Sign in to a Google account.
|
||||
|
||||
💡 TIP
|
||||
After you sign in to a Google account, you can back up the verification codes to your Google
|
||||
account for easy retrieval. To avoid situations where verification codes cannot be retrieved
|
||||
after Google Authenticator is uninstalled or data is cleared, it is recommended that you do
|
||||
not skip the login steps.
|
||||
|
||||
|
||||
iv. Do one of the following:
|
||||
Select Scan a QR code in Google Authenticator and scan the QR code in the pop-up
|
||||
window on the YMCS portal.
|
||||
|
||||
|
||||
|
||||
|
||||
Select Enter a setup key on Google Authenticator, then enter the YMCS account and
|
||||
|
||||
|
||||
12 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
the key displayed in the pop-up window, and click Add.
|
||||
|
||||
|
||||
|
||||
|
||||
v. The dynamic code is displayed in Google Authenticator.
|
||||
vi. Enter the dynamic code into YMCS and click OK.
|
||||
|
||||
|
||||
|
||||
|
||||
13 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View Term of Services and
|
||||
Privacy Policy
|
||||
View the Latest Version of the Terms of Services and
|
||||
Privacy Policy
|
||||
Procedure
|
||||
1. Do one of the following:
|
||||
For the initial login, you can check the Terms of Services and Privacy Policy after you
|
||||
enter your account credentials and click Sign In.
|
||||
After you sign in to YMCS, you can also click
|
||||
|
||||
|
||||
|
||||
|
||||
14 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> About to view the Term of Services and Privacy Policy.
|
||||
|
||||
|
||||
|
||||
|
||||
15 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
View the History Version
|
||||
Introduction
|
||||
The Terms of Service and Privacy Policy will be periodically refined and
|
||||
updated. Please read them carefully and confirm whether you wish to continue
|
||||
using the service.
|
||||
Procedure
|
||||
1. After you sign in to YMCS, click
|
||||
|
||||
|
||||
|
||||
|
||||
16 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Privacy.
|
||||
2. Select Term of Services or Privacy Policy.
|
||||
|
||||
|
||||
|
||||
|
||||
17 / 30
|
||||
@@ -0,0 +1,233 @@
|
||||
# Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 941-953
|
||||
|
||||
**Source:** Yealink Management Cloud Service(YMCS)_User Guide.pdf
|
||||
**Pages:** 941-953 of 953
|
||||
**Chunk:** 48
|
||||
|
||||
---
|
||||
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click History to view the history versions of the Terms of Services and Privacy Policy.
|
||||
|
||||
|
||||
|
||||
|
||||
18 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Add Firmware
|
||||
Introduction
|
||||
You can manage the firmware of your device in a unified way. Configure the
|
||||
relevant devices in the enterprise according to the actual situation.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware > Add.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Edit the firmware-related information.
|
||||
Select a File: Click to upload or drag the file to the specified area to upload.
|
||||
Firmware Name: The file name will be automatically filled in as the firmware name after
|
||||
uploading the file. You can also change it manually.
|
||||
Version: After uploading the file, the installation package information will be read, and
|
||||
the version number will be filled in automatically; you can also modify it manually.
|
||||
Supported Model: Select specific product model; multiple selections are available.
|
||||
Site: Select the site.
|
||||
Description: You can enter a description specific to this firmware for future traceability.
|
||||
4. Click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
19 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
20 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Manage Firmware
|
||||
Procedure
|
||||
Go to the Firmware List
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
View the Firmware List
|
||||
1. Click the site name on the left side to view the data under this site.
|
||||
2. Check the firmware name, version number, and other information in the firmware list.
|
||||
|
||||
|
||||
|
||||
|
||||
21 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
For more information, see push the firmware.
|
||||
|
||||
Copy Firmware Link
|
||||
For more information, see copy the firmware link.
|
||||
|
||||
Download Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
22 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Download to download firmware locally.
|
||||
|
||||
Edit Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
23 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Edit.
|
||||
|
||||
Delete Firmware
|
||||
1. In the firmware list, click
|
||||
|
||||
|
||||
|
||||
|
||||
24 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
> Delete.
|
||||
|
||||
|
||||
|
||||
|
||||
25 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Push Firmware
|
||||
Push Firmware Immediately
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
4. In the pop-up window, select Immediately and click Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
26 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
Push Firmware on Scheduled Time
|
||||
Introduction
|
||||
With scheduled tasks, you can choose to push the firmware during the non-
|
||||
working time without affecting the working process.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
27 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click Push on the right side of the desired firmware.
|
||||
4. Select Scheduled Tasks in the pop-up window and edit the information about the
|
||||
scheduled task. Click to Select Device.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the desired device and click Save.
|
||||
6. Complete pushing. You can check the execution status in the task management.
|
||||
|
||||
|
||||
|
||||
|
||||
28 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
Copy Firmware Link
|
||||
Introduction
|
||||
You can copy the firmware download link and share it with others. For security
|
||||
reasons, however, only devices within the enterprise can access this
|
||||
downloading link.
|
||||
Prerequisites
|
||||
Only devices within the enterprise can use this link to download the corresponding files.
|
||||
Direct access to this download link through your browser is not supported.
|
||||
Procedure
|
||||
1. Sign in to YMCS.
|
||||
2. Click Room Device > Resources > Firmware.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click
|
||||
|
||||
|
||||
|
||||
|
||||
29 / 30
|
||||
Yealink Management Cloud Service(YMCS) U...
|
||||
|
||||
|
||||
|
||||
|
||||
on the right side of the desired firmware and select Copy Link.
|
||||
|
||||
|
||||
|
||||
|
||||
30 / 30
|
||||
@@ -0,0 +1,210 @@
|
||||
# YMCS 4X Enterprise Open API Webhook.pdf - Pages 1-5
|
||||
|
||||
**Source:** YMCS 4X Enterprise Open API Webhook.pdf
|
||||
**Pages:** 1-5 of 5
|
||||
**Chunk:** 1
|
||||
|
||||
---
|
||||
|
||||
YMCS 4X Enterprise Open API Webhook
|
||||
|
||||
|
||||
|
||||
|
||||
YMCS 4X Enterprise Open API
|
||||
Webhook
|
||||
1. YMCS webhook
|
||||
1.1 Introduction
|
||||
Webhook is a user-defined callback API based on HTTP, which you can set up in
|
||||
your infrastructure to receive change notifications and events from YMCS. To use
|
||||
the YMCS webhook, users need to fill in a reliable and secure HTTPS webhook
|
||||
URL on the YMCS platform and subscribe to the events of interest.
|
||||
1.2 Webhook URL requirements
|
||||
To receive YMCS event notifications, users need to provide an accessible, HTTPS
|
||||
secure URL; otherwise, YMCS will not send notifications to the specified URL.
|
||||
1.3 Receive Event Notification
|
||||
When the subscribed event occurs, YMCS will send a notification message to the
|
||||
pre-configured request URL, and the customer application server will receive
|
||||
and respond to it.
|
||||
The transmission of notification messages is done using the HTTPS method and
|
||||
the POST approach. The message format is restricted to JSON format.
|
||||
Message format
|
||||
The HTTPS request header information is as follows:
|
||||
|
||||
Heade description
|
||||
r
|
||||
conten application/json
|
||||
t-type
|
||||
conten Content length of the request body (in bytes)
|
||||
t-
|
||||
length
|
||||
author The verification token returned after successful subscription, used
|
||||
izatio to verify that this request is sent by the YIOT system.
|
||||
1/5
|
||||
YMCS 4X Enterprise Open API Webhook
|
||||
|
||||
|
||||
|
||||
n
|
||||
client Application ID for configuring event subscriptions
|
||||
id
|
||||
x-yl- Requested trace link ID
|
||||
reques
|
||||
tid
|
||||
|
||||
Request Body format example is as follows:
|
||||
|
||||
{
|
||||
"events": [
|
||||
{
|
||||
"id": "6c29f04672b6492ebd0911c2da3414ac",
|
||||
"type": "alarm.created",
|
||||
"createTime": 1600063609555,
|
||||
"partyId": "b986e6eedd6245d697d79da86d6df57c",
|
||||
"data": {
|
||||
"id": "01d7ae1897f7418dad2d26609329be38",
|
||||
"event":"Offline",
|
||||
"level":1,
|
||||
"mac":"001565bbb1a9",
|
||||
"model":"SIP-T54S",
|
||||
"ip":"10.50.198.156",
|
||||
"site":"test"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
event object
|
||||
|
||||
Paramet Typ Description
|
||||
er e
|
||||
id Stri Event Data Unique Identifier
|
||||
ng
|
||||
type Stri Event Type
|
||||
ng
|
||||
createT Lon Business service generation event time
|
||||
ime g
|
||||
|
||||
2/5
|
||||
YMCS 4X Enterprise Open API Webhook
|
||||
|
||||
|
||||
|
||||
partyId Stri Enterprise ID
|
||||
ng
|
||||
userId Stri User ID
|
||||
ng
|
||||
data Obje Event data, format and content determined by the
|
||||
ct business.
|
||||
|
||||
Retry strategy
|
||||
After receiving the notification request sent by YMCS, the client application
|
||||
server needs to return a 200 or 204 response within 5s. Once YMCS receives this,
|
||||
it considers the message delivery successful. If the client application server does
|
||||
not respond to the notification request within 5s, YMCS will regard this
|
||||
notification as a failure and will resend the notification request according to the
|
||||
policy.
|
||||
The specific retry strategy is to retry after a certain time interval, supporting a
|
||||
maximum of 3 retries, with specific intervals of: 30s, 5m, 10m. When the retry
|
||||
period ends and the delivery is still unsuccessful, the message will not be lost; it
|
||||
will simply not attempt delivery again until new messages arrive for that
|
||||
subscription. When new messages arrive, undelivered messages within 3 days
|
||||
will be delivered according to their time.
|
||||
During the retry process, if the application server returns a 200 or 204 response within 5s, YMCS considers the
|
||||
message delivery successful and will no longer retry.
|
||||
Due to network issues or slow event processing, there may be cases of receiving duplicate events. It is
|
||||
recommended that the customer's application server perform idempotent processing or deduplication of
|
||||
events.
|
||||
|
||||
Security policy
|
||||
YMCS transmits message data via the HTTPS protocol to prevent data from
|
||||
being tampered with.
|
||||
The application server needs to validate the received requests by obtaining the
|
||||
authorization information from the request header. Only when this information
|
||||
matches the subscription verification token provided by YMCS can it be
|
||||
confirmed that the request was sent by YMCS.
|
||||
3/5
|
||||
YMCS 4X Enterprise Open API Webhook
|
||||
|
||||
|
||||
|
||||
The subscription verification token can be obtained in the YMCS event
|
||||
subscription interface.
|
||||
|
||||
2. alarm
|
||||
2.1 Generate Alarm
|
||||
Event Type: alarm.created
|
||||
Event Description: When YMCS receives a device alert, this event notification will
|
||||
be triggered.
|
||||
event data
|
||||
|
||||
Parameter Type Description
|
||||
id String Alarm ID
|
||||
event String Alert event name
|
||||
mac String MAC
|
||||
model String model
|
||||
|
||||
example
|
||||
|
||||
{
|
||||
"events": [
|
||||
{
|
||||
"id": "6c29f04672b6492ebd0911c2da3414ac",
|
||||
"type": "alarm.created",
|
||||
"createTime": 1600063609555,
|
||||
"partyId": "b986e6eedd6245d697d79da86d6df57c",
|
||||
"data": {
|
||||
"id": "01d7ae1897f7418dad2d26609329be38",
|
||||
"event":"Offline",
|
||||
"mac":"001565bbb1a9",
|
||||
"model":"SIP-T54S"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
2.2 Alarm Recovery
|
||||
Event type: alarm.recovered
|
||||
|
||||
4/5
|
||||
YMCS 4X Enterprise Open API Webhook
|
||||
|
||||
|
||||
|
||||
Event Description: When the device goes offline and then comes back online,
|
||||
the status of the registered account for the device changes from failure to
|
||||
success, which will trigger this event notification.
|
||||
event data
|
||||
|
||||
Parameter Type Description
|
||||
id String Alarm ID
|
||||
event String Alert event name
|
||||
mac String MAC
|
||||
model String Model
|
||||
|
||||
example
|
||||
|
||||
{
|
||||
"events": [
|
||||
{
|
||||
"id": "6c29f04672b6492ebd0911c2da3414ac",
|
||||
"type": "alarm.recovered",
|
||||
"createTime": 1600063609555,
|
||||
"partyId": "b986e6eedd6245d697d79da86d6df57c",
|
||||
"data": {
|
||||
"id": "01d7ae1897f7418dad2d26609329be38",
|
||||
"event":"Online",
|
||||
"mac":"001565bbb1a9",
|
||||
"model":"SIP-T54S",
|
||||
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
5/5
|
||||
226
.claude/skills/yealink-ymcs/scripts/chunk-pdf-docs.py
Executable file
226
.claude/skills/yealink-ymcs/scripts/chunk-pdf-docs.py
Executable file
@@ -0,0 +1,226 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
chunk-pdf-docs.py - Break large PDF documentation into bite-sized markdown chunks
|
||||
|
||||
Extracts text from large PDFs and splits them into manageable sections for easier
|
||||
processing and documentation. Designed for YMCS API documentation PDFs.
|
||||
|
||||
Usage:
|
||||
python3 chunk-pdf-docs.py <input.pdf> [--output-dir <dir>] [--pages-per-chunk <n>]
|
||||
python3 chunk-pdf-docs.py --all # Process all YMCS PDFs in Downloads
|
||||
|
||||
Options:
|
||||
--output-dir PATH Output directory for chunks (default: ./docs/chunks/)
|
||||
--pages-per-chunk N Pages per chunk (default: 25)
|
||||
--all Process all YMCS PDFs from Downloads folder
|
||||
--toc-only Extract just the table of contents
|
||||
--help Show this help
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import re
|
||||
from pathlib import Path
|
||||
|
||||
def extract_text_with_pdftotext(pdf_path, page_start=None, page_end=None):
|
||||
"""Extract text using pdftotext (poppler-utils)"""
|
||||
import subprocess
|
||||
|
||||
cmd = ['pdftotext', '-layout', '-nopgbrk']
|
||||
|
||||
if page_start and page_end:
|
||||
cmd.extend(['-f', str(page_start), '-l', str(page_end)])
|
||||
|
||||
cmd.extend([str(pdf_path), '-'])
|
||||
|
||||
try:
|
||||
result = subprocess.run(cmd, capture_output=True, text=True, check=True)
|
||||
return result.stdout
|
||||
except subprocess.CalledProcessError as e:
|
||||
print(f"[ERROR] pdftotext failed: {e}", file=sys.stderr)
|
||||
return None
|
||||
except FileNotFoundError:
|
||||
print("[ERROR] pdftotext not found. Install with: brew install poppler", file=sys.stderr)
|
||||
return None
|
||||
|
||||
def get_pdf_page_count(pdf_path):
|
||||
"""Get total page count using pdfinfo"""
|
||||
import subprocess
|
||||
|
||||
try:
|
||||
result = subprocess.run(['pdfinfo', str(pdf_path)],
|
||||
capture_output=True, text=True, check=True)
|
||||
for line in result.stdout.split('\n'):
|
||||
if line.startswith('Pages:'):
|
||||
return int(line.split(':')[1].strip())
|
||||
return None
|
||||
except:
|
||||
return None
|
||||
|
||||
def sanitize_filename(name):
|
||||
"""Convert section name to safe filename"""
|
||||
name = re.sub(r'[^\w\s-]', '', name.lower())
|
||||
name = re.sub(r'[-\s]+', '-', name)
|
||||
return name.strip('-')
|
||||
|
||||
def extract_toc(pdf_path):
|
||||
"""Extract table of contents from first 20 pages"""
|
||||
text = extract_text_with_pdftotext(pdf_path, 1, 20)
|
||||
if not text:
|
||||
return []
|
||||
|
||||
# Look for common TOC patterns
|
||||
toc_entries = []
|
||||
in_toc = False
|
||||
|
||||
for line in text.split('\n'):
|
||||
line = line.strip()
|
||||
|
||||
# Start of TOC markers
|
||||
if re.match(r'table\s+of\s+contents', line, re.I):
|
||||
in_toc = True
|
||||
continue
|
||||
|
||||
# End of TOC markers
|
||||
if in_toc and (line.startswith('Chapter') or line.startswith('1 ') or line.startswith('1.')):
|
||||
in_toc = False
|
||||
|
||||
# Extract TOC entries (line ending with page number)
|
||||
if in_toc:
|
||||
match = re.match(r'^(.+?)\s+\.{2,}\s*(\d+)$', line)
|
||||
if match:
|
||||
title, page = match.groups()
|
||||
toc_entries.append({'title': title.strip(), 'page': int(page)})
|
||||
|
||||
return toc_entries
|
||||
|
||||
def chunk_pdf(pdf_path, output_dir, pages_per_chunk=25):
|
||||
"""Break PDF into chunks"""
|
||||
pdf_path = Path(pdf_path)
|
||||
output_dir = Path(output_dir)
|
||||
output_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Get total pages
|
||||
total_pages = get_pdf_page_count(pdf_path)
|
||||
if not total_pages:
|
||||
print(f"[ERROR] Could not determine page count for {pdf_path.name}")
|
||||
return False
|
||||
|
||||
print(f"[INFO] Processing {pdf_path.name} ({total_pages} pages)")
|
||||
|
||||
# Extract TOC
|
||||
print("[INFO] Extracting table of contents...")
|
||||
toc = extract_toc(pdf_path)
|
||||
if toc:
|
||||
toc_path = output_dir / f"{pdf_path.stem}-TOC.md"
|
||||
with open(toc_path, 'w') as f:
|
||||
f.write(f"# Table of Contents - {pdf_path.name}\n\n")
|
||||
for entry in toc:
|
||||
f.write(f"- Page {entry['page']}: {entry['title']}\n")
|
||||
print(f"[OK] Saved TOC to {toc_path.name} ({len(toc)} entries)")
|
||||
|
||||
# Create chunks
|
||||
chunk_num = 1
|
||||
page_start = 1
|
||||
|
||||
while page_start <= total_pages:
|
||||
page_end = min(page_start + pages_per_chunk - 1, total_pages)
|
||||
|
||||
print(f"[INFO] Extracting chunk {chunk_num} (pages {page_start}-{page_end})...")
|
||||
|
||||
text = extract_text_with_pdftotext(pdf_path, page_start, page_end)
|
||||
|
||||
if text:
|
||||
chunk_path = output_dir / f"{pdf_path.stem}-chunk-{chunk_num:02d}-p{page_start}-{page_end}.md"
|
||||
|
||||
with open(chunk_path, 'w') as f:
|
||||
f.write(f"# {pdf_path.name} - Pages {page_start}-{page_end}\n\n")
|
||||
f.write(f"**Source:** {pdf_path.name}\n")
|
||||
f.write(f"**Pages:** {page_start}-{page_end} of {total_pages}\n")
|
||||
f.write(f"**Chunk:** {chunk_num}\n\n")
|
||||
f.write("---\n\n")
|
||||
f.write(text)
|
||||
|
||||
print(f"[OK] Saved {chunk_path.name}")
|
||||
else:
|
||||
print(f"[WARNING] Failed to extract chunk {chunk_num}")
|
||||
|
||||
page_start = page_end + 1
|
||||
chunk_num += 1
|
||||
|
||||
print(f"[OK] Created {chunk_num - 1} chunks in {output_dir}")
|
||||
return True
|
||||
|
||||
def process_all_ymcs_pdfs(output_base_dir, pages_per_chunk):
|
||||
"""Process all YMCS PDFs from Downloads"""
|
||||
downloads = Path.home() / 'Downloads'
|
||||
|
||||
pdfs = [
|
||||
downloads / 'Open API for Yealink Management Cloud Service V4X.pdf',
|
||||
downloads / 'YMCS 4X Enterprise Open API Webhook.pdf',
|
||||
downloads / 'Yealink Management Cloud Service(YMCS)_User Guide.pdf',
|
||||
downloads / 'Yealink Management Cloud Service(YMCS)_Channel User Guide.pdf',
|
||||
]
|
||||
|
||||
for pdf in pdfs:
|
||||
if not pdf.exists():
|
||||
print(f"[WARNING] Not found: {pdf.name}")
|
||||
continue
|
||||
|
||||
# Create subdirectory for each PDF
|
||||
pdf_output_dir = Path(output_base_dir) / sanitize_filename(pdf.stem)
|
||||
|
||||
print(f"\n{'='*70}")
|
||||
print(f"Processing: {pdf.name}")
|
||||
print(f"Output: {pdf_output_dir}")
|
||||
print(f"{'='*70}\n")
|
||||
|
||||
chunk_pdf(pdf, pdf_output_dir, pages_per_chunk)
|
||||
|
||||
def main():
|
||||
import argparse
|
||||
|
||||
parser = argparse.ArgumentParser(
|
||||
description='Break large PDF documentation into bite-sized chunks',
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
epilog=__doc__
|
||||
)
|
||||
|
||||
parser.add_argument('pdf', nargs='?', help='PDF file to process')
|
||||
parser.add_argument('--output-dir', default='./docs/chunks',
|
||||
help='Output directory (default: ./docs/chunks)')
|
||||
parser.add_argument('--pages-per-chunk', type=int, default=25,
|
||||
help='Pages per chunk (default: 25)')
|
||||
parser.add_argument('--all', action='store_true',
|
||||
help='Process all YMCS PDFs from Downloads')
|
||||
parser.add_argument('--toc-only', action='store_true',
|
||||
help='Extract just table of contents')
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
if args.all:
|
||||
skill_dir = Path(__file__).parent.parent
|
||||
output_dir = skill_dir / 'docs' / 'chunks'
|
||||
process_all_ymcs_pdfs(output_dir, args.pages_per_chunk)
|
||||
elif args.pdf:
|
||||
pdf_path = Path(args.pdf)
|
||||
if not pdf_path.exists():
|
||||
print(f"[ERROR] File not found: {pdf_path}")
|
||||
sys.exit(1)
|
||||
|
||||
if args.toc_only:
|
||||
toc = extract_toc(pdf_path)
|
||||
if toc:
|
||||
print(f"\nTable of Contents ({len(toc)} entries):\n")
|
||||
for entry in toc:
|
||||
print(f" Page {entry['page']:4d}: {entry['title']}")
|
||||
else:
|
||||
print("[WARNING] No TOC found")
|
||||
else:
|
||||
chunk_pdf(pdf_path, args.output_dir, args.pages_per_chunk)
|
||||
else:
|
||||
parser.print_help()
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user