Delete BGM
1. API Description
This API is used to delete a song from the BGM list.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/bgm/remove-bgm-from-list
- V2.5.0 and below: POST [ip]/mwapi/remove-bgm-from-list
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
Deleting the song with ID 203 from the BGM list.
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 |
39 | MW_STATUS_MISMATCH | The BGM does not exist |
48 | MW_STATUS_INFO_CHANGED | Prohibit operations on non-current presentation content |