tencent cloud

Chat

제품 소개
제품 개요
Basic Concepts
응용 시나리오
기능 소개
계정 시스템
사용자 정보 및 관계망
메시지 관리
그룹 시스템
Official Account
Audio/Video Call
사용 제한
구매 가이드
과금 개요
요금 안내
Purchase Instructions
Renewal Guide
연체 안내
Refund Policy
다운로드 센터
SDK & Demo 소스 코드
업데이트 로그
시나리오 솔루션
Live Streaming Setup Guide
AI Chatbot
대규모 엔터테인먼트 협업 커뮤니티
Discord 구현 가이드
IM을 게임에 통합하는 방법
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
클라이언트 APIs
SDK API(Web)
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
서버 APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
콘솔 가이드
New Console Introduction
애플리케이션 생성 및 업그레이드
기본 설정
기능 설정
계정 관리
그룹 관리
Official Channel Management
콜백 설정
모니터링 대시보드
Viewing Guide for Resource Packages
Real-Time Monitor
개발 보조 툴
액세스 관리
Advanced Features
FAQ
uni-app FAQs
구매
SDK 관련 질문
계정 인증
사용자 정보 및 관계망
메시지
그룹
라이브 방송 그룹
닉네임 및 프로필 사진
협약 및 인증
Service Level Agreement
컴플라이언스 인증
IM 정책
개인 정보 보호 정책
데이터 개인 정보 보호 및 보안 계약
에러 코드
문의하기
문서Chat

Webhook for agent assignment

포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-02-28 17:33:59

Function Description

Administrators can use this interface to obtain information related to requests for transferring to human customer service and assign agents based on business logic.

Please Note

To enable this webhook, it must be configured in the Desk management panel with a webhook URL set up, and the customer service allocation method set to Assigned by Webhook.
The direction of the webhook is an HTTPS POST request initiated by the Instant Messaging Chat backend to the App backend.
Upon receiving the webhook request, the App backend must verify that the SDKAppID parameter in the request URL matches its own SDKAppID.
For additional security-related considerations, please refer to the "Webhook Overview: Security Considerations" document.

Scenarios That May Trigger This Webhook

This webhook may be triggered when a user in a session initiates a request to transfer to human customer service, and the application is configured to assign agents by webhook.

Timing of the Webhook

When the application is set to assign agents by webhook, this webhook is triggered by the Chat backend when a user in the session initiates a request for transferring to human customer service.

Interface Description

Webhook URL Example

In the following example, the App's configured webhook URL is https://www.example.com.

Example:

Request Parameter Description

Parameter
Description
https
The request protocol is HTTPS, and the method is POST
www.example.com
Callback URL
SdkAppid
The SDKAppID assigned in the Instant Messaging Chat console when creating the application
CallbackCommand
Fixed as ChatBot.OnAssignAgent
contenttype
Fixed value as JSON
ClientIP
Client IP, format such as: 127.0.0.1
OptPlatform
Client platform, see the "Webhook Overview: Webhook Protocol" for
the meaning of parameters in OptPlatform

Request Package Example

{
    "CallbackCommand": "ChatBot.OnAssignAgent",		//Webhook command
    "SessionId":"aa-bb-cc-dd",		//SessionID of the conversation
  	"ClientUserId":"123",		// User ID of the client triggering the request for human assistance
    "EventTime": 1670574414123		//Timestamp
}

Request Package Field Description

Field
Type
Description
CallbackCommand
String
Webhook command
SessionId
String
SessionID of the conversation
ClientUserId
String
User ID of the client triggering the request for human assistance
EventTime
String
Timestamp of the event in milliseconds

Response Package Example

After synchronizing data, the App backend sends a webhook response package.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
  	"AgentGroupId": 6521,		//Agent Group ID sent from your end
  	"AgentIdList": ["penn_svc","dramon_svc"] //List of agent sent from your end
}

Response Package Field Description

Field
Type
Attribute
Description
ActionStatus
String
Required
Result of the request processing:
OK for success
FAIL for failure
ErrorCode
Integer
Required
Error code:
0 for successful processing and sends RspData back to the smart robot
1 for failure, RspData is ignored
AgentGroupId
Integer
Optional
ID of the agent group returned from your end; if only this field is provided, the Chat backend will assign agent from this agent group
AgentIdList
Array
Optional
List of agents returned from your end; if specified, one agent from the list will be assigned based on availability rules
다음 주제: 제품 개요

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백