tencent cloud

Cloud Contact Center

DokumentasiCloud Contact CenterDesk API ReferenceCallback ConfigurationAPI Call

API Call

Mode fokus
Ukuran font
Terakhir diperbarui: 2025-05-15 14:57:44

Description

API call callbacks are used in the nodes of multi-turn task API calls, mainly to callback some session-related information (such as user ID, customer service account ID) or other custom application information to the business backend.

Reminder

To enable the callback, you must configure it in the multi-round task API call node of Desk Management Console.
The direction of the callback is that the Chat backend sends HTTP POST requests to the App backend.
After receiving an event notification, process the internal logic asynchronously and synchronously return a successful response for receipt.
After receiving a callback request, the App backend needs to verify whether the value of the SDKAppID parameter in the request URL is its own SDKAppID.
For other security-related matters, see Security Considerations in Webhook Overview.

API Description

Sample Request URL

In the following example, the callback URL configured for the App is https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request Parameters

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Callback URL
SdkAppid
Assigned SDKAppID in the Chat console when creating an application
CallbackCommand
Fixed as Chatbot.InterfaceInvocation
contenttype
The value is fixed as JSON.
ClientIP
Client IP address. For example, 127.0.0.1.

Sample Request Packet

{
    "CallbackCommand": "Chatbot.InterfaceInvocation",  // Callback command word
    "Body":         // Variable value passed-through to business
  	{		
        "SystemClientUserID": "user517",        // System variable, uid
        "SystemSessionID": "207cac25-f49e-4ada-9c9f-301cea31dcf2", // System variable, SessionID
        "staticKey": "staticValue",        // Fixed value
        "testKey3": "" // Custom Variable
    },
    "EventTime": 1731488371784
}

Request Packet Fields

Field
Type
Required or Not
Description
CallbackCommand
String
Yes
The callback command word is fixed as Chatbot.InterfaceInvocation.
Body
Object
Yes
The package passed through to the business side contains a map, where the key is the variable name and the value is the variable value. Specific variable types can refer to the API call node in the multi-round task.
EventTime
Integer
Yes
Timestamp.

Sample Response Packet

The response packet is returned after the App backend synchronizes the data.
{
  "ActionStatus":"OK",
  "ErrorInfo":"",
  "ErrorCode":0,
  "Body": 
  {
    "testKey1":"value1", // Variable returned by the business
    "testKey3":"10"
  }
}

Response Packet Fields

Field
Type
Required or Not
Description
ErrorCode
Integer
Yes
Error code: 0 for success, others for failure.
ErrorInfo
String
Yes
Error message.
ActionStatus
String
Yes
Request processing result. OK means processing successful.
Body
Object
No
Packet returns Desk with a map where the key is the variable name and the value is the variable data, which will be populated into the corresponding session variables.




Topik sebelumnya: Session Event CallbackTopik selanjutnya: FAQs

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan