- News and Announcements
- Release Notes
- Announcements
- Announcement: Chat Push Service Adaptation for Honor Push Standards
- Announcement: Renaming of Chat Premium to Pro Edition
- Announcement on New Billing for Delivered Messages in the IM Community Feature
- Announcement on Chat's Adaptation to MiPush's Discontinuation of Custom Notification Message
- Termination of Earlier Server Key Method for Chat FCM Push
- TRTC Call Official Editions Launched
- Tencent Cloud IM renamed
- Adjustment of Subscription Plans for Chat
- Product Introduction
- Purchase Guide
- Development Guidelines
- Demo Zone
- Download
- Chat Interaction (UI Included)
- TUIKit Library
- Getting Started
- Integrating TUIKit
- Only integrate chat
- Build Basic Interfaces
- Modifying UI Themes
- Setting UI Styles
- Implementing Local Search
- Integrating Offline Push
- User Online Status
- Typing Status
- Message Read Receipt
- Message Reactions
- Message Quotation
- Internationalization
- Adding Custom Messages
- Emoji & Stickers
- Custom UI components
- Video Call (UI Included)
- Overview (TUICallKit)
- Activate Service（TUICallKit）
- Integration(TUICallKit)
- UI Customization (TUICallKit)
- Additional Features(TUICallKit)
- API Documentation(TUICallKit)
- Release Notes (TUICallKit)
- Push Feature
- Desk
- More Practices
- No UI Integration
- Quick Start
- 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
- Voice-to-Text
- 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
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Getting the List of Online Members in Community Group
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- 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
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- Console Guide
- FAQs
- Security Compliance Certification
- Chat Policies
- Migration
- Error Codes
- Contact Us
- News and Announcements
- Release Notes
- Announcements
- Announcement: Chat Push Service Adaptation for Honor Push Standards
- Announcement: Renaming of Chat Premium to Pro Edition
- Announcement on New Billing for Delivered Messages in the IM Community Feature
- Announcement on Chat's Adaptation to MiPush's Discontinuation of Custom Notification Message
- Termination of Earlier Server Key Method for Chat FCM Push
- TRTC Call Official Editions Launched
- Tencent Cloud IM renamed
- Adjustment of Subscription Plans for Chat
- Product Introduction
- Purchase Guide
- Development Guidelines
- Demo Zone
- Download
- Chat Interaction (UI Included)
- TUIKit Library
- Getting Started
- Integrating TUIKit
- Only integrate chat
- Build Basic Interfaces
- Modifying UI Themes
- Setting UI Styles
- Implementing Local Search
- Integrating Offline Push
- User Online Status
- Typing Status
- Message Read Receipt
- Message Reactions
- Message Quotation
- Internationalization
- Adding Custom Messages
- Emoji & Stickers
- Custom UI components
- Video Call (UI Included)
- Overview (TUICallKit)
- Activate Service（TUICallKit）
- Integration(TUICallKit)
- UI Customization (TUICallKit)
- Additional Features(TUICallKit)
- API Documentation(TUICallKit)
- Release Notes (TUICallKit)
- Push Feature
- Desk
- More Practices
- No UI Integration
- Quick Start
- 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
- Voice-to-Text
- 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
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Getting the List of Online Members in Community Group
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- 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
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 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?