- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Chat Interaction (UI Included)
- Video Call (UI Included)
- Desk
- Quick Start
- Integration Guide
- Configure Channels
- Admin Operation Manual
- Configure Agent to Proactively Contact Chat Users
- Login to Management End
- Third-party extension
- Agent Management
- Agent Role Permission Management
- Online Status and Reasons for Short Break
- Skill Group Management
- Session Service Flow Management
- Satisfaction Evaluation
- Quick Reply
- Session Routing and Reception Settings
- Agent Operation Manual
- AI Chatbot
- More Practices
- How to intergrate TUIChat independently in Uniapp（Vue2 & Vue3）
- How to intergrate TUIChat independently in Web（Vue2 & Vue3）
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- No UI Integration
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Reaction
- Message Translation
- Message Pinning
- Conversation
- Group
- Community Topic
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Chatbot webhooks
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Chat Interaction (UI Included)
- Video Call (UI Included)
- Desk
- Quick Start
- Integration Guide
- Configure Channels
- Admin Operation Manual
- Configure Agent to Proactively Contact Chat Users
- Login to Management End
- Third-party extension
- Agent Management
- Agent Role Permission Management
- Online Status and Reasons for Short Break
- Skill Group Management
- Session Service Flow Management
- Satisfaction Evaluation
- Quick Reply
- Session Routing and Reception Settings
- Agent Operation Manual
- AI Chatbot
- More Practices
- How to intergrate TUIChat independently in Uniapp（Vue2 & Vue3）
- How to intergrate TUIChat independently in Web（Vue2 & Vue3）
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- No UI Integration
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Reaction
- Message Translation
- Message Pinning
- Conversation
- Group
- Community Topic
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Chatbot webhooks
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
Caution
TCCC is a global variable that can be accessed directly after loading the SDK.
General structure
AgentStatus
Seat Status.
Field | Description |
free | Available |
busy | Busy |
arrange | Organizing information |
notReady | Not ready yet |
rest | Short break |
CommonSDKResponse
Parameter | Type | Required | Remarks | |
options | status | 'success' |'error' | Yes | SDK API call result: Successful: returns 'success' Failure: returns 'error' |
| errorMsg | string | No | Error information, returns when the status is error |
Chat (Apis related to customer service)
Access the Conversation
tccc.Chat.accept(options): Promise<CommonSDKResponse>
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
End the session
tccc.Chat.end(options): Promise<CommonSDKResponse>
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
Transfer session
tccc.Chat.transfer(): Promise<CommonSDKResponse>
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
| skillGroupId | String | No | Transferred skill group |
| userId | String | No | Transferred agent |
Agent (Apis related to agent status)
Launch
tccc.Agent.online(): void
Decommission
tccc.Agent.offline(): void
Set agent status
tccc.Agent.setStatus(optoins): Promise<CommonSDKResponse>
Parameter | Type | Required | Remarks | |
options | status | String | Yes | Agent status, valid values: free rest Arrange NotReady StopNotReady |
| restReason | String | No | Short break reason |
Obtaining Agent Status
tccc.Agent.getStatus():AgentStatus
Devices (Device-related API Functions)
Detect Whether the Current Browser is Supported
tccc.Devices.isBrowserSupported(): boolean
Note
TCCC Web SDK supports browsers Chrome 56 or above, or Edge 80 or above.
Get the microphone device list
tccc.Devices.getMicrophones(): Promise<MediaDeviceInfo []>
Get the speaker device list
tccc.Devices.getSpeakers(): Promise<MediaDeviceInfo []>
UI (Apis related to UI)
Hide all UI of SDK
tccc.UI.hide(): void
Display all UI of SDK
tccc.UI.show(): void
Display Floating Button
tccc.UI.showfloatButton(): void
Hide Floating Button
tccc.UI.hidefloatButton(): void
Show Workbench
tccc.UI.showWorkbench(): void
Hide Workbench
tccc.UI.hideWorkbench(): void
Events
Listening for events
tccc.on(event, callback)
Canceling Event Listening
tccc.off(event, callback)
SDK Initialization Completed
tccc.events.ready
Triggered When SDK Initialization is Complete, APIs Can Now Be Safely Invoked.
Incoming Session
tccc.events.callIn
Types of call-in conversations include:
phone: Telephonic conversation
im: Online conversation
voip: Audio conversation
video: Video conversation
Internal: Internal Conversation
Online Conversation Incoming
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
| type | 'phone' | Yes | Conversation Type |
| timeout | Number | Yes | Session access timeout duration, 0 represents no timeout |
| nickname | String | Yes | User's nickname |
| avatar | String | No | User profile photo |
| remark | String | No | Remarks |
| peerSource | String | No | Channel Source |
| channelName | String | No | Custom Parameters |
| clientData | String | No | User-Defined Parameters |
Agent Accesses Session
tccc.events.userAccessed
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
Session Timeout Transfer Event
tccc.events.autoTransfer
Parameter | Type | required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
Conversation End Event
tccc.events.sessionEnded
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
| closeBy | String | Yes | Indication of end party: client: User end seat: Agent end admin: System end timer: Timer end |
| mainReason | String | No | This field only exists in phone calls and when the hang-up party is 'admin' indicating the reason for the hang-up. |
| subReason | String | No | This field only exists in phone calls and when the hang-up party is 'admin' indicating the detailed reason for the hang-up. |
Session Transfer Event
tccc.events.transfer
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Conversation ID |
Agent Status Change Event
tccc.events.statusChanged
Parameter | Type | Required | Remarks | |
options | status | No | ||
Yes
No
Was this page helpful?