Help Center/ Speech Interaction Service/ API Reference/ Hot Word Management APIs/ Deleting a Hot Word Table
Updated on 2025-08-26 GMT+08:00
View PDF
Share

Deleting a Hot Word Table

Function

This API is used to delete a hot word table based on its ID.

URI

DELETE /v1/{project_id}/asr/vocabularies/{vocabulary_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

vocabulary_id

Yes

String

ID of the hot word table to be deleted.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It is used to obtain the permission to call APIs. For details about how to obtain a user token, see Authentication. The token is the value of X-Subject-Token in the response header.

Response Parameters

No response message will be returned. If HTTP status code 200 is returned, the table is deleted successfully.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned when the API fails to be called. This parameter is not included when the API is successfully called.

error_msg

String

Error message returned when the API fails to be called. This parameter is not included when the API is successfully called.

Example Requests

The endpoint is the request URL for calling an API. Endpoints vary according to services and regions. For details, see Endpoints.

  • Delete a hot word table. 
    DELETE https://{endpoint}/v1/{project_id}/asr/vocabularies/{vocabulary_id}

Request header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

Example Responses

Status code: 400

Failure response example

{
  "error_code" : "SIS.0201",
  "error_msg" : "***"
}

Status Code

For details about status codes, see Status Codes.

Error Code

For details about error codes, see Error Codes.

Parent topic: Hot Word Management APIs