tencent cloud

Cloud Contact Center

DocumentaçãoCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseBulk Update Chatbot Small Talk Library Question Status

Bulk Update Chatbot Small Talk Library Question Status

Modo Foco
Tamanho da Fonte
Última atualização: 2025-03-31 20:11:17

API Call Description

App admin invokes RESTful APIs to batch update chatbot smalltalk library.
Caution:
Take effect directly on the live network after being set via REST API (set and published in the management console).

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/batch_set_chitchat?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please see REST API Introduction.
Parameter
Description
v4/openim_console_http_svc/batch_set_chitchat
Request API.
sdkappid
Assigned SDKAppID in the IM console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Signature generated by the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0,4294967295].
contenttype
The request format has a fixed value of json.

Maximum Calling Frequency

5 times/second.

Sample Request Packet

{
    "StandardQuestionIds": [
        "1500086040-@RBT#DeskDefaultRobot-qJLb9mKIA4bmdv9j"
    ],
    "Status":4
}

Request Packet Fields

Field
Type
Description
StandardQuestionIds
Array
ID list of standard questions to be updated.
Status
Integer
Status after update.
Status enumeration:
4 - Enable in production environment.
5 - Disable in production environment.
6 - Delete in production environment.

Response Packet Body Example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

Response Packet Fields

Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: processing failed.
ErrorCode
Integer
Error code: 0 indicates success, non-zero indicates failure.
ErrorInfo
String
Error message.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
-7
Parameter parsing failed. Check whether the request packet conforms to the JSON Specification or the request parameters meet requirements.
-14
Exceeds the maximum frequency limit allowed by this API.
-20
Request requires App administrator permissions.
-50003
Desk resource is invalid.
-50040
Number of Suggestions: Return to 'n' matches each time guided.
-50011
Delete the system preset category.

API Debugging Tool

Debug this interface using the online debugging tool for REST API.

References

Query one-to-one chat messages (v4/openim/admin_getroammsg)
Anterior: Delete Chatbot FAQ Library CategoryPróximo: Bulk Update Chatbot FAQ Status

Ajuda e Suporte

Esta página foi útil?

comentários