POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentenceByCategoryId
Scenario
This interface is invoked to obtain the list of sentences in a sentence category based on its unique ID.
Method
POST
URI
https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/sentencemanage/querySentenceByCategoryId (For example, the domain name is service.besclouds.com.)
Request Description
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
Content-Type |
String |
No |
The value is fixed to application/json; charset=UTF-8. |
2 |
x-app-key |
String |
No |
App key |
3 |
Authorization |
String |
Yes |
Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.) |
4 |
x-UserId |
String |
No |
Operator ID You can sign in to the system and go to the employee management page to view the value of userId returned by an interface. |
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
category_id |
String |
Yes |
Unique ID of a sentence category |
1.2 |
page |
Number |
Yes |
Page number |
1.3 |
limit |
Number |
Yes |
Number of records on each page
|
Response Description
- Status code: 200
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
data |
Array [Object] |
No |
Result content |
1.1.1 |
sentence_id |
String |
No |
Unique ID of a sentence |
1.1.2 |
sentence_name |
String |
No |
Sentence name |
1.1.3 |
category_id |
String |
No |
Unique ID of a sentence category |
1.2 |
paging |
Object |
No |
Pagination information |
1.2.1 |
total |
String |
No |
Total number of query results |
1.3 |
resultCode |
String |
No |
Return code
|
1.4 |
resultDesc |
String |
No |
Return description |
- Status code: 400
Incorrect request. Check the request path and parameters.
- Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
- Status code: 404
The requested content is not found. Check the request path.
- Status code: 500
Business failure. Check the values of parameters in the request.
Error Codes
None
Example
- Scenario: Obtain the list of sentences in a sentence category based on its unique ID.
x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ********************************
Request parameters:
{ "category_id": "1070149256381206528", "page": 1, "limit": 10 }
Response parameters:
{ "data": [ { "category_id": "1070149256381206528", "sentence_id": "10849", "sentence_name": "Sentence name 87" }, { "category_id": "1070149256381206528", "sentence_id": "10856", "sentence_name": "Sentence name 96" }, { "category_id": "1070149256381206528", "sentence_id": "10863", "sentence_name": "Sentence name 403" }, { "category_id": "1070149256381206528", "sentence_id": "10870", "sentence_name": "Sentence name 78" }, { "category_id": "1070149256381206528", "sentence_id": "10877", "sentence_name": "Sentence name 25" }, { "category_id": "1070149256381206528", "sentence_id": "10884", "sentence_name": "Sentence name 39" }, { "category_id": "1070149256381206528", "sentence_id": "10891", "sentence_name": "Sentence name 85" } ], "resultCode": "0403000", "paging": { "total": 7 }, "resultDesc": "Operation successful." }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot