Switch BGM
1. API Description
This API is used to switch the specified song.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/bgm/switch-bgm
- V2.5.0 and below: POST [ip]/mwapi/switch-bgm
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| id | Yes | Int | The resource ID of current BGM, that is the unique identifier of the audio file in the device, which can be obtained via Get BGM list. |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| message | String | Status description |
4. Example
Switching to the song with ID 203.
Input Example
{
"id":203
}
Output Example
{
"message": "success",
"status": 0
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Status | Definition | Description |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | Missing required parameters |