tencent cloud

APIs

Cloud Virtual Machine
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Tencent Cloud Lighthouse
History
Introduction
API Category
Making API Requests
Image APIs
Firewall APIs
Key APIs
Instance APIs
CCN APIs
Snapshot APIs
Other APIs
Cloud Disk APIs
Scene APIs
Package APIs
Quota APIs
Region APIs
Data Types
Error Codes
Auto Scaling
History
Introduction
API Category
Making API Requests
Scaling Group APIs
Scaling Group Instances APIs
Launch Configuration APIs
Scheduled Action APIs
Alarm Trigger Policy APIs
Notification APIs
Lifecycle Hook APIs
Instance Refresh APIs
Other APIs
Data Types
Error Codes
Batch Compute
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
Tencent Cloud Automation Tools
History
Introduction
API Category
Making API Requests
Remote Command APIs
Scheduled Execution APIs
Managed Instance APIs
Scenario APIs
Statistics APIs
Data Types
Error Codes
Edge Computing Machine
History
API Category
Making API Requests
Region APIs
Module APIs
Instance APIs
Image APIs
VPC APIs
Subnet APIs
Route Table APIs
CLB APIs
ENI APIs
EIP APIs
HAVIP APIs
Other API
Key APIs
Security Group APIs
Data Types
Error Codes
Tencent Kubernetes Engine
History
Introduction
API Category
Making API Requests
Elastic Cluster APIs
Resource Reserved Coupon APIs
Cluster APIs
Third-party Node APIs
Relevant APIs for Addon
Network APIs
Node APIs
Node Pool APIs
TKE Edge Cluster APIs
Cloud Native Monitoring APIs
Scaling group APIs
Super Node APIs
Other APIs
Data Types
Error Codes
TKE API 2022-05-01
Tencent Container Registry
History
Introduction
API Category
Making API Requests
Instance Management APIs
Namespace APIs
Access Control APIs
Instance Synchronization APIs
Tag Retention APIs
Trigger APIs
Helm Chart APIs
Image Repository APIs
Custom Account APIs
Data Types
Error Codes
Tencent Cloud Elastic Microservice
History
Introduction
API Category
Making API Requests
Environment APIs
ModifyIngress
Resource APIs
Application APIs
Service APIs
Application Deployment APIs
Access Policy APIs
Configuration file APIs
Log collecting APIs
Scaling Rule APIs
Application Version APIs
Other APIs
Workload APIs
Data Types
Error Codes
Serverless Cloud Function
History
Introduction
API Category
Making API Requests
Other APIs
Namespace APIs
Layer Management APIs
Async Event Management APIs
Trigger APIs
Function APIs
Function and Layer Status Description
Data Types
Error Codes
Event Bridge
History
Introduction
API Category
Making API Requests
Delivery Target APIs
Event Bus APIs
Event Rule APIs
Event Connector APIs
Data Transformer APIs
Event Storage APIs
Data Types
Error Codes
Cloud Object Storage
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
Cloud File Storage
History
Introduction
API Category
Snapshot APIs
File system APIs
Lifecycle APIs
Other APIs
Data Flow APIs
Making API Requests
Permission Group APIs
Service APIs
Scaling APIs
Data Migration APIs
Data Types
Error Codes
Cloud Block Storage
History
Introduction
API Category
Making API Requests
Snapshot APIs
Cloud Disk APIs
Data Types
Error Codes
Cloud HDFS
History
Introduction
API Category
Making API Requests
Other APIs
Permission group APIs
Permission rule APIs
Mount point APIs
Lifecycle rule APIs
File system APIs
Restoration task APIs
Data Types
Error Codes
Cloud Log Service
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
Kafka Task APIs
Kafka Data Subscription APIs
COS Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
TDSQL-C for MySQL
History
Introduction
API Category
Making API Requests
Instance APIs
Multi-Availability Zone APIs
Other APIs
Audit APIs
Database Proxy APIs
Backup and Recovery APIs
Parameter Management APIs
Billing APIs
serverless APIs
Resource Package APIs
Account APIs
Performance Analysis APIs
Data Types
Error Codes
TencentDB for MySQL
History
Introduction
API Category
Instance APIs
Making API Requests
Data Import APIs
Database Proxy APIs
Database Audit APIs
Security APIs
Task APIs
Backup APIs
Account APIs
Rollback APIs
Parameter APIs
Database APIs
Monitoring APIs
Log-related API
Data Types
Error Codes
TencentDB for MariaDB
History
Introduction
API Category
Making API Requests
Security Group APIs
Other APIs
Account APIs
Parameter Management APIs
Monitoring Management APIs
Instance Management APIs
Backup and Restoration APIs
Data Types
Error Codes
TencentDB for PostgreSQL
History
Introduction
API Category
Making API Requests
Instance APIs
Read-only Replica APIs
Backup and Recovery APIs
Parameter Management APIs
Security Group APIs
Performance Optimization APIs
Account APIs
Specification APIs
Network APIs
Data Types
Error Codes
TencentDB for SQL Server
History
Introduction
API Category
Making API Requests
Sales and fee related APIs
Instance Management related APIs
Operation and maintenance management related APIs
Network management related APIs
Account management related APIs
Database management related APIs
Security group management related APIs
Data security encryption related APIs
Parameter configuration related APIs
Extended Event related APIs
Log management related APIs
Read only instance management related APIs
Publish and subscribe related APIs
Backup related APIs
Data migration (cold standby migration) related APIs
Rollback related APIs
Data migration (DTS old version) related APIs
SQL Server Integration Services (SSIS) related APIs
Data Types
Error Codes
TDSQL for MySQL
History
Introduction
API Category
Security Group APIs
Other APIs
Making API Requests
TDSQL APIs
Data Types
Error Codes
Tencent Cloud Distributed Cache (Redis OSS-Compatible)
History
Introduction
API Category
Making API Requests
Instance APIs
Parameter Management APIs
Other APIs
Backup and Restoration APIs
Region APIs
Monitoring and Management APIs
Log APIs
Data Types
Error Codes
TencentDB for MongoDB
History
Introduction
API Category
Making API Requests
Instance APIs
Backup APIs
Account APIs
Other APIs
Task APIs
Introduction
Data Types
Error Codes
TencentDB for TcaplusDB
History
Introduction
API Category
Making API Requests
Table Group APIs
Other APIs
Table APIs
Cluster APIs
Data Types
Error Codes
Data Transfer Service
History
Introduction
API Category
Making API Requests
(NewDTS) Data Migration APIs
Data Sync APIs
Data Consistency Check APIs
(NewDTS) Data Subscription APIs
Data Types
Error Codes
DTS API 2018-03-30
TencentDB for DBbrain
History
Introduction
Introduction
API Category
Making API Requests
Session Killing APIs
Exception Detection APIs
Other APIs
Redis related APIs
Health Report Email Sending APIs
Space Analysis APIs
Security Audit APIs
Slow Log Analysis APIs
Database Audit APIs
Data Types
Error Codes
DBbrain APIs 2019-10-16
Virtual Private Cloud
History
Introduction
API Category
Making API Requests
VPC APIs
Route Table APIs
Elastic Public IP APIs
Elastic IPv6 APIs
Highly Available Virtual IP APIs
ENI APIs
Bandwidth Package APIs
NAT Gateway APIs
Direct Connect Gateway APIs
Cloud Connect Network APIs
Network ACL APIs
Network Parameter Template APIs
Network Detection-Related APIs
Flow Log APIs
Gateway Traffic Monitor APIs
Private Link APIs
Traffic Mirroring APIs
Other APIs
Subnet APIs
VPN Gateway APIs
Security Group APIs
Snapshot Policy APIs
Error Codes
Data Types
Cloud Load Balancer
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
Direct Connect
History
Introduction
API Category
Making API Requests
Direct Connect APIs
Data Types
Error Codes
Content Delivery Network
History
Introduction
API Category
Content Management APIs
Real-time Log APIs
Service Query APIs
Data Query APIs
Making API Requests
Log Query APIs
Domain Name Management APIs
Configuration Management APIs
Obsoleted APIs
Other APIs
Data Types
Error Codes
Global Application Acceleration Platform
History
Introduction
API Category
Rule APIs
Connection Group APIs
Making API Requests
Origin Server APIs
Listener APIs
Connection APIs
Certificate APIs
Other APIs
Data Types
Error Codes
Tencent Cloud Firewall
History
Introduction
API Category
Making API Requests
Intrusion Defense APIs
Access Control APIs
Other APIs
Enterprise Security Group APIs
Firewall Status APIs
Data Types
Error Codes
Tencent Cloud EdgeOne
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
Cloud Workload Protection Platform
History
Introduction
API Category
Asset Management APIs
Virus Scanning APIs
Abnormal Log-in APIs
Password Cracking APIs
Malicious Request APIs
High-Risk Command APIs
Local Privilege Escalation APIs
Reverse Shell APIs
Vulnerability Management APIs
New Baseline Management APIs
Baseline Management APIs
Advanced Defense APIs
Security Operation APIs
Expert Service APIs
Other APIs
Overview Statistics APIs
Settings Center APIs
Making API Requests
Intrusion Detection APIs
Data Types
Error Codes
Key Management Service
History
Introduction
API Category
Key APIs
Making API Requests
Asymmetric Key APIs
Data Types
Error Codes
Secrets Manager
History
Introduction
API Category
Making API Requests
Data Security APIs
Other APIs
Data Types
Error Codes
Captcha
History
Introduction
API Category
Making API Requests
Server APIs
Error Codes
Customer Identity and Access Management
History
Introduction
API Category
Making API Requests
User Management APIs
Data Sync APIs
Audit Management APIs
Data Types
Error Codes
Security Token Service
History
Introduction
API Category
Making API Requests
STS APIs
Data Types
Error Codes
SSL Certificates
History
Introduction
API Category
Making API Requests
Certificate APIs
Certificate Renewal (Certificate ID Unchanged) APIs
CSR APIs
Data Types
Error Codes
Private DNS
History
Introduction
API Category
Making API Requests
Private DNS APIs
Data Types
Error Codes
DNSPod
History
Introduction
API Category
Making API Requests
Line APIs
Package and Value-Added Service APIs
Batch Operation APIs
Group APIs
Record APIs
DNS Query Volume APIs
Alias APIs
Domain APIs
Data Types
Error Codes
Elastic MapReduce
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
Elasticsearch Service
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
Data Lake Compute
History
Introduction
API Category
Making API Requests
Data Table APIs
Task APIs
Metadata APIs
Service Configuration APIs
Permission Management APIs
Database APIs
Data Source Connection APIs
Data Optimization APIs
Data Engine APIs
Resource Group for the Standard Engine APIs
Data Types
Error Codes
Face Recognition
History
Introduction
API Category
Making API Requests
Face Detection and Analysis APIs
Facial Feature Localization APIs
Face Comparison APIs
Group Management APIs
Face Search APIs
Face Verification APIs
Image-based Liveness Detection (High Precision) APIs
Data Types
Error Codes
eKYC
History
Introduction
API Category
Making API Requests
Selfie Verification (Pure API) APIs
Selfie Verification (App SDK) APIs
Identity Verification (App SDK) APIs
Identity Verification(Mobile HTML5) APIs
AI Face Shield (Pure API) APIs
Other APIs
Data Types
Error Codes
Text To Speech
History
Introduction
API Category
Making API Requests
General Text-to-Speech APIs
Data Types
Error Codes
Tencent Machine Translation
History
Introduction
API Category
Making API Requests
APIs
Error Codes
Optical Character Recognition
History
Introduction
API Category
Making API Requests
Document Intelligent APIs
Card and Document OCR APIs
General Text OCR APIs
Vehicle Scene OCR APIs
Data Types
Error Codes
IoT Hub
History
Introduction
API Category
Making API Requests
Device Shadow APIs
Device APIs
CA Certificate APIs
Product APIs
Data Types
Error Codes
TDMQ for CKafka
History
Introduction
API Category
Making API Requests
Other APIs
ACL APIs
Instance APIs
Routing APIs
DataHub APIs
Topic APIs
Data Types
Error Codes
Cloud Message Queue
History
API Category
Making API Requests
Topic APIs
Queue APIs
Introduction
Data Types
Error Codes
Chat
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Short Message Service
History
Introduction
API Category
Making API Requests
SMS Mobile Number APIs
SMS Conversion Rate APIs
Status Pull APIs
SMS Statistics APIs
SMS Signature APIs
SMS Delivery APIs
SMS Template APIs
Data Types
Error Codes
SMS Callback APIs
Tencent Push Notification Service
Overview
API Overview
Call Method
Push APIs
Tag APIs
Account APIs
Statistics APIs
User Attribute APIs
Server-Side Error Codes
Server SDKs
API (Java)
Simple Email Service
History
Introduction
API Category
Making API Requests
Domain Verification APIs
Mail APIs
Template APIs
Statistics APIs
Sender Address APIs
Blocklist APIs
Sending Status Query APIs
Batch Task APIs
Custom Blocklist APIs
Data Types
Error Codes
Tencent Real-Time Communication
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
StreamLive
History
Introduction
API Category
Making API Requests
Input Management APIs
Input Security Group Management APIs
Channel Management APIs
Plan APIs
Watermark Management APIs
Statistics APIs
Data Types
Error Codes
StreamPackage
History
Introduction
API Category
Making API Requests
Channel Management APIs
Advertising Insertion Configuration Management APIs
Channel linear assembly management APIs
VOD remux task APIs
Usage Query APIs
HarvestJob Management APIs
Data Types
Error Codes
StreamLink
History
API Category
Making API Requests
Flow APIs
Data Types
Error Codes
Cloud Streaming Services
History
Introduction
API Category
Making API Requests
Live Pad APIs
Live Stream Mix APIs
Time Shifting APIs
Monitoring Data Query APIs
Billing Data Query APIs
Live Transcoding APIs
Delayed Playback Management APIs
Domain Name Management APIs
Watermark Management APIs
Certificate Management APIs
Stream Pulling APIs
Recording Management APIs
Live Callback APIs
Screencapturing and Porn Detection APIs
Authentication Management APIs
Live Stream Management APIs
Data Types
Error Codes
Video on Demand
History
Introduction
API Category
Other APIs
Media Processing APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Parameter Template APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
Media Processing Service
History
Introduction
API Category
Making API Requests
Processing Task Initiation APIs
Task Management APIs
Transcoding and Enhancement Template APIs
Watermark Template APIs
Screenshot Template APIs
Media AI Template APIs
Media AI—Hotword Lexicon APIs
Media AI—Sample Management APIs
Media Quality Inspection Template APIs
Live Streaming Recording Template APIs
Orchestration Management APIs
Data Statistics APIs
StreamLink—Security Group Management APIs
Other APIs
Image Processing Template APIs
AI Generation APIs
Other APIs
Data Types
Error Codes
Cloud Application Rendering
History
Introduction
API Category
Making API Requests
User APIs
Application Management APIs
Project Management APIs
Concurrency Management APIs
Stream Push Service APIs
Data Types
Error Codes
Game Multimedia Engine
History
Introduction
API Category
Usage APIs
Recording APIs
Making API Requests
Voice Chat APIs
Application APIs
Data Types
Error Codes
Tag
History
Introduction
API Category
Making API Requests
Write APIs
Read APIs
Project APIs
Data Types
Error Codes
Cloud Access Management
History
Introduction
API Category
Making API Requests
User APIs
Policy APIs
Role APIs
Identity Provider APIs
Data Types
Error Codes
CloudAudit
History
Introduction
API Category
Calling Method
CloudAudit APIs
Data Types
Error Codes
Tencent Cloud Organization
History
Introduction
API Category
Making API Requests
Organization Settings APIs
Department and Member Management APIs
Unified Member Login APIs
Member Access Management APIs
Organization Service Management APIs
Organization Management Policy APIs
Resource Sharing APIs
Identity Center Management APIs
Identity Center User Management APIs
Identity Center User Group Management APIs
Identity Center Management SCIM Synchronization APIs
Identity Center Single Sign-On Management APIs
Identity Center Permission Configuration Management APIs
Identity Center Multi-Account Authorization Management APIs
Identity Center Sub-User Synchronization Management APIs
Data Types
Error Codes
TCO API 2018-12-25
Tencent Cloud Observability Platform
History
Introduction
API Category
Making API Requests
Monitoring Data Query APIs
Alarm APIs
Legacy Alert APIs
Notification Template APIs
TMP APIs
Grafana Service APIs
Event Center APIs
TencentCloud Managed Service for Prometheus APIs
Monitoring APIs
Data Types
Error Codes
Real User Monitoring
History
Introduction
API Category
Making API Requests
Console APIs
Business System and Project Information APIs
Custom Speed Test APIs
Custom Event APIs
API Monitoring APIs
Exception Analysis APIs
Page View APIs
Static Resource Monitoring APIs
Log APIs
Page Performance APIs
Data Types
Error Codes
International Partners
History
Introduction
API Category
Making API Requests
Customer Management APIs
Credit Management APIs
Agent APIs
Bill Management APIs
Voucher Management APIs
Commission Management APIs
Data Types
Error Codes
Billing Center
API Category
Funds Management APIs
Order Management APIs
Resource Management APIs
Bill Management APIs
Cost Allocation Management APIs
Cost Management APIs
Making API Requests
Organization Account APIs
Data Types
Error Codes
TDSQL Boundless
History
Introduction
API Category
Making API Requests
Instance APIs
Security Group APIs
Task APIs
Backup APIs
Rollback APIs
Parameter APIs
Database APIs
Data Types
Error Codes
TDMQ for MQTT
History
Introduction
API Category
Making API Requests
Cluster APIs
Topic APIs
Authorization Policy APIs
User APIs
Client APIs
Message APIs
Message Enhancement Rule APIs
Data Types
Error Codes
Tencent HY
History
Introduction
API Category
Making API Requests
Hunyuan Text APIs
Hunyuan 3D APIs
Data Types
Error Codes
Smart Media Hosting
History
Introduction
API Category
Making API Requests
PaaS Service APIs
Official Cloud Disk APIs
Data Types
Error Codes
Quota Center
History
Introduction
API Category
Making API Requests
Alarm APIs
Data Types
Error Codes
Message Center
History
Introduction
API Category
Making API Requests
Message Subscription APIs
Data Types
Error Codes
Business Intelligence
History
Introduction
API Category
Making API Requests
Project Management APIs
Role APIs
Database Table APIs
Report Embedding APIs
Page Management APIs
Data Types
Error Codes
LLM Knowledge Engine Basic API
History
Introduction
API Category
Making API Requests
Atomic Capability APIs
Data Types
Error Codes
Tencent Cloud Agent Development Platform
History
API Category
Making API Requests
Atomic Capability APIs
Operation Optimization APIs
Document Library APIs
Q&A Database APIs
Knowledge Tag APIs
Application Management APIs
Enterprise Management APIs
Billing APIs
Release Management APIs
Dialogue Endpoint APIs
Data Statistics APIs
Data Types
Error Codes
Tencent Cloud Blockchain as a Service
History
Introduction
API Category
Making API Requests
Hyperledger Fabric 2.3 APIs
Data Types
Error Codes
Performance Testing Service
History
Introduction
API Category
Making API Requests
PTS-related APIs
Data Types
Error Codes
Real-time Teleoperation
History
Introduction
API Category
Making API Requests
Project APIs
Device APIs
Session APIs
Authorization APIs
Other APIs
Data Types
Error Codes
Gateway Load Balancer
History
Introduction
API Category
Making API Requests
Target Group APIs
GWLB APIs
Other APIs
Data Types
Error Codes
Identity Aware Platform
History
Introduction
API Category
Making API Requests
IAP APIs
Error Codes
Cloud Dedicated Cluster
History
Introduction
API Category
Making API Requests
Cloud Dedicated Cluster (CDC) APIs
Data Types
Error Codes
Image Creation Large Model
History
Introduction
API Category
Making API Requests
Image Style Transfer APIs
Data Types
Error Codes
Face Fusion
API Category
Making API Requests
Image Face Fusion (Basic) APIs
Video Face Fusion (Single Face) APIs
Data Types
Error Codes
Tencent Smart Advisor-Chaotic Fault Generator
History
Introduction
API Category
Making API Requests
Task APIs
Template Library APIs
Data Types
Error Codes
Tencent HealthCare Omics Platform
History
Introduction
API Category
Making API Requests
Environment Management APIs
Tencent Healthcare Omics Platform APIs
Data Types
Error Codes
Tencent Cloud TCHouse-D
History
Introduction
API Category
Making API Requests
Cluster Operation APIs
Database and Table APIs
Cluster Information Viewing APIs
Hot-Cold Data Layering APIs
Database and Operation Audit APIs
User and Permission APIs
Resource Group Management APIs
Data Types
Error Codes
Tencent Cloud WeData
History
Introduction
API Category
Making API Requests
Project Management APIs
Smart Ops Related Interfaces
Resource Group APIs
Data Development APIs
Data Asset - Data Dictionary APIs
Data Development APIs
Ops Center APIs
Data Exploration APIs
Data Operations Related Interfaces
Asset APIs
Metadata Related Interfaces
Task Operations APIs
Data Security APIs
Instance Operation and Maintenance Related Interfaces
Data Map and Data Dictionary APIs
Data Quality Related Interfaces
DataInLong APIs
Platform Management APIs
Data Source Management APIs
Data Quality APIs
Platform Management APIs
Asset Data APIs
Data Source Management APIs
Data Types
Error Codes
WeData API 2025-08-06
Anti-DDoS
History
Introduction
API Category
Making API Requests
Anti-DDoS Advanced Instance APIs
Resource List APIs
Protection Configuration APIs
Other APIs
Alarm Notification APIs
Connection Configuration APIs
Intelligent Scheduling APIs
Black hole unblocking APIs
Statistical Report APIs
Data Types
Error Codes
Cloud Contact Center
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Tencent Cloud Super App as a Service
History
Introduction
API Category
Making API Requests
Operation Management APIs
Platform Management APIs
Sensitive API-Related APIs
Role Management APIs
Team Management APIs
Other Console APIs
Mini Program or Mini Game APIs
Management-Sensitive APIs
Global Domain Management APIs
Superapp APIs
User Management APIs
Data Types
Tencent Cloud Smart Advisor
History
Introduction
API Category
Making API Requests
Other APIs
Task APIs
Cloud Architecture Console APIs
Data Types
Error Codes
TDMQ for RabbitMQ
History
Introduction
API Category
Making API Requests
Relevant APIs for RabbitMQ Serverless PAAS Capacity
RabbitMQ Serverless Instance Management APIs
Data Types
Error Codes
Control Center
History
Introduction
API Category
Making API Requests
Account Factory APIs
Data Types
Error Codes
TDMQ for CMQ
API Documentation
API 2.0 to 3.0 Switch Guide
Tencent Cloud TCHouse-P
History
Introduction
API Category
Making API Requests
Information Query APIs
Instance APIs
Query APIs
Cluster Management APIs
Cluster Operation APIs
Data Types
Error Codes
TDMQ for RocketMQ
History
API Category
Making API Requests
Topic APIs
Consumer Group APIs
Message APIs
Role Authentication APIs
Hitless Migration APIs
Cloud Migration APIs
Cluster APIs
Data Types
Error Codes
Cloud Dedicated Zone
History
Introduction
API Category
Making API Requests
Availability Zone APIs
Data Types
Error Codes
Tencent Cloud Health Dashboard
History
Introduction
API Category
Making API Requests
Event APIs
Data Types
Error Codes
Application Performance Management
History
Introduction
API Category
Making API Requests
Application APIs
Business System APIs
General Query APIs
Unavailable APIs
Performance Analysis APIs
Data Types
Error Codes
Config
History
Introduction
API Category
Making API Requests
Rule APIs
Resource APIs
Data Types
Error Codes
Automatic Speech Recognition
History
Introduction
API Category
Making API Requests
Recording Recognition APIs
Real-Time Speech Recognition APIs
Data Types
Error Codes
Tencent Cloud TI Platform
History
Introduction
API Category
Making API Requests
Online Service APIs
Data Types
Error Codes
Web Application Firewall
History
Introduction
API Category
Making API Requests
Asset Management APIs
Billing APIs
Protection Settings APIs
Other APIs
IP Management APIs
Integration APIs
Log Service APIs
Security Overview APIs
Rule Engine APIs
Data Types
Error Codes
Cloud Security Center
History
Introduction
API Category
Making API Requests
Multi-account management related APIs
Scan Task APIs
Risk Center APIs
Asset Center APIs
Cloud Boundary Analysis APIs
Cloud API Anomaly Detection APIs
Report Download APIs
Solid Protection APIs
Cloud Security Center Overview APIs
Data Types
Error Codes
Risk Control Engine
History
Introduction
API Category
Making API Requests
TencentCloud API APIs
Data Types
Error Codes
TencentDB for CTSDB
History
Introduction
API Category
Making API Requests
Instance APIs
Database APIs
Data Types
Error Codes
Tencent Interactive Whiteboard
History
Introduction
API Category
Making API Requests
Whiteboard Push APIs
Other APIs
Document Transcoding APIs
Real-Time Recording APIs
Statistics Query APIs
Whiteboard Snapshot APIs
Recording Video Generation APIs
Data Types
Error Codes
Tencent Container Security Service
History
Introduction
API Category
Making API Requests
Network Security APIs
Cluster Security APIs
Security Compliance APIs
Runtime security - High-risk syscalls
Runtime Security - Reverse Shell APIs
Runtime Security APIs
Alert Settings APIs
Advanced prevention - K8s API abnormal requests
Asset Management APIs
Security Operations - Log Analysis APIs
Runtime Security - Trojan Call APIs
Runtime Security - Container Escape APIs
Image Security APIs
Billing APIs
Data Types
Error Codes
Domains
History
Introduction
API Category
Making API Requests
Domain Management APIs
Domain Query APIs
Bulk Operation APIs
Registrant Profile APIs
Other APIs
Data Types
Error Codes
Low-code Interactive Classroom
History
Introduction
API Category
Making API Requests
User Login APIs
Room Management APIs
Group Management APIs
Application Configuration APIs
Recording Management APIs
Courseware Management APIs
User Management APIs
Developer APIs
Data Types
Error Codes
DokumentasiAPIsCloud Contact CenterData Types

Data Types

Mode fokus
Ukuran font
Terakhir diperbarui: 2026-03-27 10:45:52

AIAgentInfo

Intelligent agent info.

Used by actions: DescribeAIAgentInfoList.

Name Type Description
AIAgentId Integer Intelligent agent ID.
AIAgentName String Intelligent agent name.
VariableNames Array of String List of intelligent agent variable names.

AIAnalysisResult

AI conversation analytics result.

Used by actions: DescribeAIAnalysisResult.

Name Type Description
Type String Summary: describes the session summary.
mood: specifies the emotion analysis.
intention extraction.
Result String AI session analysis result.

AICallExtractConfigElement

AI call extraction configuration item.

Used by actions: CreateAICall.

Name Type Required Description
InfoType String Yes Configuration item type, including.
Text.
Selector option.
Boolean value.
Number.
InfoName String Yes Configuration item name, duplicat.
InfoContent String No Specific content of the configuration item.
Examples Array of String No Example of extracted content from the configuration item.
Choices Array of String No When infotype is selector, this field needs to be configured.

AICallExtractResultElement

AI call extraction result.

Used by actions: DescribeAICallExtractResult.

Name Type Description
InfoType String Type of extracted information.
Text.
Selector options.
Boolean value.
Number.
InfoName String Name of the extracted information.
InfoContent String Specific description of the extracted information.
Result AICallExtractResultInfo Specific result of the extracted information.

AICallExtractResultInfo

Specific information of AI call result.

Used by actions: DescribeAICallExtractResult.

Name Type Description
Text String The extracted type is text.
Chosen Array of String The extracted type is option.
Boolean Boolean The extracted type is a boolean value.
Number Float The extracted type is a number.

AILatencyDetail

AI latency details.

Used by actions: DescribeAILatency.

Name Type Description
RoundId String Dialog ID.
ASRLatency Integer Specifies the asr latency in milliseconds.
TTSLatency Integer Specifies the tts delay in milliseconds.
LLMLatency Integer llm latency (ms).
LLMFirstTokenLatency Integer llm first token latency (ms).
ETELatency Integer End-To-End delay (ms).

AILatencyStatistics

AI latency statistics.

Used by actions: DescribeAILatency.

Name Type Description
ASRLatency AILatencyStatisticsInfo Specifies the asr latency statistics.
TTSLatency AILatencyStatisticsInfo Specifies the statistics of tts delay.
LLMLatency AILatencyStatisticsInfo llm latency statistics.
ETELatency AILatencyStatisticsInfo Specifies the end-to-end latency statistics.

AILatencyStatisticsInfo

AI latency statistics.

Used by actions: DescribeAILatency.

Name Type Description
MinLatency Integer Specifies the minimum value.
MiddleLatency Integer Specifies the median.
P90Latency Integer p90

AITransferItem

AI to human configuration item.

Used by actions: CreateAICall.

Name Type Required Description
TransferFunctionName String Yes Name of the function calling for transfer to human.
TransferFunctionDesc String Yes Takes effect when transferfunctionenable is true; the description of transfer_to_human function calling defaults to "transfer to human when the user has to transfer to human (like says transfer to human) or you are instructed to do so.".
TransferSkillGroupId Integer Yes Skill group id for transferring to human agent.

AsrData

Speech-to-text information

Used by actions: DescribeTelRecordAsr.

Name Type Description
User String User side.
Message String Message content.
Start Integer Sentence start time, unix millisecond timestamp.
End Integer Sentence end time, unix millisecond timestamp.

AudioFileInfo

Audio file review information

Used by actions: DescribeIvrAudioList, UploadIvrAudio.

Name Type Description
FileId Integer File id.
CustomFileName String File alias.
AudioFileName String Filename.
Status Integer Review status: 0 - unreviewed, 1 - approved, 2 - rejected.

AutoCalloutTaskCalleeInfo

Outbound call task called information.

Used by actions: DescribeAutoCalloutTask.

Name Type Description
Callee String Called number.
State Integer Call status 0 - initial, 1 - answered, 2 - unanswered, 3 - calling, 4 - pending retry.
Sessions Array of String List of session ids.

AutoCalloutTaskInfo

Automatic outbound call task list item.

Used by actions: DescribeAutoCalloutTasks.

Name Type Description
Name String Task name.
CalleeCount Integer Number of called parties.
Callers Array of String List of calling numbers.
NotBefore Integer Start timestamp.
NotAfter Integer End timestamp
.
Note: this field may return null, indicating that no valid values can be obtained.
IvrId Integer IvrId used by the task.
State Integer Task status:.
0 initial: task created, call not started.
1: running.
2 completed: all calls in the task are done.
3 ending: the task expires, but some calls are not ended.
4 stopped: the task expired and ended.
5 paused: recoverable to continue execution.
TaskId Integer .
MaxRingTimeoutSecond Integer Maximum ringing duration. auto hang up when the duration threshold is reached. only own number supports this parameter.

CallInMetrics

Real-Time inbound metric.

Used by actions: DescribeCallInMetrics.

Name Type Description
IvrCount Integer Number of ivr residency.
QueueCount Integer Number in queue.
RingCount Integer Number in ringing.
AcceptCount Integer Number of connections.
TransferOuterCount Integer Number of customer service transferring to the external line.
MaxQueueDuration Integer Maximum queue duration.
AvgQueueDuration Integer Average queue duration.
MaxRingDuration Integer Maximum ringing duration.
AvgRingDuration Integer Average ringing duration.
MaxAcceptDuration Integer Maximum connection duration.
AvgAcceptDuration Integer Average connection duration.

CallInNumberMetrics

Inbound line dimension metrics.

Used by actions: DescribeCallInMetrics.

Name Type Description
Number String Line number.
Metrics CallInMetrics Line-Related metrics.
SkillGroupMetrics Array of CallInSkillGroupMetrics Bound skill group metrics.

CallInSkillGroupMetrics

Inbound capability group metrics.

Used by actions: DescribeCallInMetrics.

Name Type Description
SkillGroupId Integer Skill group id.
Metrics CallInMetrics Data metrics.
Name String Skill group name.

CalleeAttribute

Property of the called.

Used by actions: CreateAutoCalloutTask, CreatePredictiveDialingCampaign, UpdatePredictiveDialingCampaign.

Name Type Required Description
Callee String Yes Called number.
UUI String No Accompanying data.
Variables Array of Variable No Parameter.

ClientInfo

Terminal information of the logged-in agent.

Used by actions: DescribeStaffStatusMetrics.

Name Type Description
ClientType String Endpoint type for login. "Web" means Web workbench. "WeChatMiniProgram" refers to wechat mini program.
IsConnected Boolean Whether the currently logged-in endpoint is in the foreground. if the endpoint is Web, the value is true. if the endpoint is WeChatMiniProgram, true indicates the wechat mini program is open, and false indicates it is in the background.

DescribePredictiveDialingCampaignsElement

Query the predictive outbound call task list elements.

Used by actions: DescribePredictiveDialingCampaigns.

Name Type Description
CampaignId Integer .
Name String Task name.
Status Integer Task status 0 - ready to start, 1 - in progress, 2 - paused, 3 - terminated, 4 - completed.
StatusReason Integer Task status reasons 0 - normal, 1 - manually ended, 2 - ended due to overtime.
CalleeCount Integer Number of called numbers.
FinishedCalleeCount Integer Number of completed calls.
Priority Integer Running priority of multiple tasks in the same application, from high to low 1 - 5.
SkillGroupId Integer ID of the used skill group of agents.

ErrStaffItem

When adding customer service personnel in batches, information of the customer service personnel with an error is returned.

Used by actions: CreateStaff.

Name Type Description
StaffEmail String Agent email address.
Code String Error code.
Message String Error description.

EventStaffDetail

Event details.

Used by actions: DescribeSessionDetail.

Name Type Required Description
Staffs Array of EventStaffElement No Specifies the agent data.

EventStaffElement

Agent information.

Used by actions: DescribeSessionDetail.

Name Type Required Description
Mail String No Agent email address.
StaffNumber String No Agent id.

ExtensionInfo

Telephone information.

Used by actions: DescribeExtensions.

Name Type Description
SdkAppId Integer Instance id.
FullExtensionId String Extension full name.
ExtensionId String Extension.
SkillGroupId String Affiliated skill group list.
ExtensionName String Extension name.
CreateTime Integer Creation time.
ModifyTime Integer Last modification time.
Status Integer Telephone status (0 offline, 100 free, 200 busy).
Register Boolean Whether to register.
Relation String Bind agent email.
RelationName String Bind agent name.

ForwardingConfig

Call forwarding configuration.

Used by actions: DescribeStaffInfoList, ModifyStaff.

Name Type Required Description
Enabled Boolean No Whether to enable.
Condition Integer No 1 unconditional call forwarding 2 conditional call forwarding.
Target ForwardingTarget No Call forwarding destination.

ForwardingTarget

Call forwarding destination.

Used by actions: ModifyStaff.

Name Type Required Description
Type Integer No Call forwarding target type. valid values: 1 (agent), 2 (skill group), 3 (extension).
StaffUserId String No Specifies the agent account when the call forwarding target is set to agent and Type is 1.
SkillGroupId Integer No Specifies the ID of the skill group as the call forwarding target. fill when Type is 2.
Extension String No The account to which the call is forwarded is an extension. fill when Type is 3.

IVRKeyPressedElement

IVR Key Information.

Used by actions: DescribeProtectedTelCdr, DescribeSessionDetail, DescribeTelCdr.

Name Type Description
Key String Hit keyword or press.
Label String Tag associated with the key.
Timestamp Integer UNIX millisecond timestamp.
NodeLabel String Node tags.
OriginalContent String User'S original input.
TTSPrompt String TTS prompt content.

Interface

Callback api.

Used by actions: BindNumberCallInInterface.

Name Type Required Description
URL String Yes API address

InvokeLLM

Service invocation actively initiates requests to the LLM.

Used by actions: ControlAIConversation.

Name Type Required Description
Content String No Specifies the content of the LLM request.
Interrupt Boolean No Whether the text is allowed to interrupt the robot speaking.

NumberInfo

Number information.

Used by actions: DescribeNumbers.

Name Type Description
Number String Number.
CallOutSkillGroupIds Array of Integer Bound outbound call skill group.
State Integer Number status, 1-normal, 2-disabled due to overdue payment, 4-disabled by the administrator, 5-disabled due to violation.

OwnNumberApplyDetailItem

User-owned number approval detail data type

Used by actions: CreateOwnNumberApply, ModifyOwnNumberApply.

Name Type Required Description
CallType Integer Yes Number type: 0 - inbound
PhoneNumber String Yes Line number.
MaxCallCount Integer Yes Maximum concurrent call number.
MaxCallPSec Integer Yes Maximum number of concurrencies per second.
OutboundCalleeFormat String No Outbound called number format, use {+e.164} or {e.164}.
CarrierPhoneNumber String No Specifies the carrier number.

PSTNSession

PSTN session type.

Used by actions: DescribeTelSession.

Name Type Description
SessionID String Session id.
RoomID String Temporary room id for session.
Caller String Caller.
Callee String Called.
StartTimestamp Integer Start time. unix timestamp.
RingTimestamp Integer Ring time. unix timestamp.
AcceptTimestamp Integer Answer time. unix timestamp.
StaffEmail String Agent email.
StaffNumber String Agent id.
SessionStatus String Session status.
Ringing - in progress.
SeatJoining - waiting for the agent to answer.
InProgress: in progress.
Finished - completed.
Direction Integer Session call direction, 0 - inbound
OutBoundCaller String The number used for transferring to the external line (outbound caller).
OutBoundCallee String Outbound callee.
ProtectedCaller String Caller number protection id. effective when the number protection map feature is activated, and the caller field is empty.
ProtectedCallee String Called number protection id. effective when the number protection map feature is activated, and the callee field is empty.

PSTNSessionInfo

PSTN Session Information.

Used by actions: DescribePSTNActiveSessionList.

Name Type Description
SessionID String Session id.
RoomID String Temporary room id for session.
Caller String Caller.
Callee String Called.
StartTimestamp String Start time. unix timestamp.
AcceptTimestamp String Answer time. unix timestamp.
StaffEmail String Agent email.
StaffNumber String Agent id.
SessionStatus String Agent status inprogress ongoing.
Direction Integer Session call direction, 0 - inbound
RingTimestamp Integer Ring time. unix timestamp.
ProtectedCaller String Caller number protection id. effective when the number protection map feature is activated, and the caller field is empty.
ProtectedCallee String Called number protection id. effective when the number protection map feature is activated, and the callee field is empty.

PackageBuyInfo

Package purchase information.

Used by actions: DescribeCCCBuyInfoList.

Name Type Description
PackageId String Package id.
Type Integer Package type, 0 - outbound call package
CapacitySize Integer .
CapacityRemain Integer Remaining package balance.
BuyTime Integer Purchased timestamp.
EndTime Integer Deadline timestamp.

PhoneNumBuyInfo

Number purchase information.

Used by actions: DescribeCCCBuyInfoList.

Name Type Description
PhoneNum String Telephone number.
Type Integer Number type, 0 - landline
CallType Integer Call type of the number, 1 - inbound
BuyTime Integer Purchased timestamp.
EndTime Integer Deadline timestamp.
State Integer Number status, 1-normal

SdkAppIdBuyInfo

Application purchase information.

Used by actions: DescribeCCCBuyInfoList.

Name Type Description
SdkAppId Integer Application id.
Name String Application name.
StaffBuyNum Integer Agent purchase count (still within the validity period).
StaffBuyList Array of StaffBuyInfo Agent purchase list (still within the validity period).
PhoneNumBuyList Array of PhoneNumBuyInfo List of numbers purchased.
SipBuyNum Integer Number of office telephones purchased (still within the validity period).

SeatUserInfo

Agent User Information

Used by actions: CreateStaff, DescribeProtectedTelCdr, DescribeTelCdr.

Name Type Required Description
Name String Yes Agent name.
Mail String Yes Agent email.
StaffNumber String Yes Worker number.
Phone String No Agent'S telephone number (with 0086 prefix).
Nick String No Agent nickname.
UserId String No User id.
SkillGroupNameList Array of String No List of skill groups associated with the agent.
Role Integer No 1: admin.
2: quality inspector.
3: ordinary agent.
Else: custom role id.
ExtensionNumber String No Agent extension number (starting with 1 to 8, 4 - 6 digits).

ServeParticipant

Participant information.

Used by actions: DescribeProtectedTelCdr, DescribeSessionDetail, DescribeTelCdr.

Name Type Description
Mail String Agent email.
Phone String Agent phone number.
RingTimestamp Integer Ringing timestamp, unix second-level timestamp.
AcceptTimestamp Integer Answer timestamp. unix second-level timestamp.
EndedTimestamp Integer End timestamp. unix second-level timestamp.
RecordId String Recording id can be indexed to the agent side recording.
Type String Participant type: "staffseat", "outboundseat", "staffphoneseat".
TransferFrom String Transfer source agent information.
TransferFromType String Transfer source participant type is consistent with the type value.
TransferTo String Transfer destination agent information.
TransferToType String Transfer destination participant type, which is consistent with type values.
SkillGroupId Integer Skill group id.
EndStatusString String End status.

For chinese description, see https://www.tencentcloud.com/zh/document/product/1229/71847.

For english details, see reference.
RecordURL String Recording url.
Sequence Integer Participant sequence number, starting from 0.
StartTimestamp Integer Start timestamp. unix second-level timestamp.
SkillGroupName String Skill group name.
CustomRecordURL String Address of the third-party cos for transferring recording.

ServerPushText

Server controls the chatbot to broadcast specified text.

Used by actions: ControlAIConversation.

Name Type Required Description
Text String No Specifies the server push broadcast text.
Interrupt Boolean No Whether to allow the text to interrupt the robot's speaking.
StopAfterPlay Boolean No Specifies whether to automatically close the dialogue task after broadcasting the text.
Audio String No Specifies the server push broadcast audio.
Format description: audio must be mono, sampling rate should be consistent with the corresponding TTS, and coded as a Base64 string.
Input rules: when the Audio field is provided, the system will not accept input in the Text field. the system will play the Audio content in the Audio field directly.
DropMode Integer No Defaults to 0. valid only when Interrupt is false.
-0 indicates that messages with Interrupt set to false will be dropped when there is an interaction.
-Indicates that when there is an interaction in progress, messages with Interrupt set to false will not be dropped but cached and processed after the current interaction is completed.

Note: when DropMode is 1, the cache allows multiple messages. if an interruption occurs subsequently, cached messages will be cleared.
Priority Integer No Message priority of ServerPushText. 0 means interruptible. 1 means not interruptible.
Note: after receiving a message with Priority=1, any other messages will be ignored (including messages with Priority=1) until the message processing of Priority=1 is complete. this field can be used together with the Interrupt and DropMode fields.
Example.
-Priority=1, Interrupt=true. specifies to Interrupt existing interaction and broadcast immediately. the broadcast will not be interrupted during the process.
-Priority=1, Interrupt=false, DropMode=1. waits for the current interaction to complete before broadcasting. the broadcast will not be interrupted during the process.
AddHistory Boolean No Specifies whether the text is added to the llm history context.

SessionEvent

Call event.

Used by actions: DescribeSessionDetail.

Name Type Required Description
Timestamp Integer No Event timestamp. Unix second-level timestamp.
EventType String No Event type. currently supports StaffHold, StaffUnhold, StaffMute, StaffUnmute.
StaffEventDetail EventStaffDetail No Describes event details related to the agent.

SetStaffStatusItem

Describes the information item for creating a staff.

Used by actions: SetStaffStatus.

Name Type Required Description
StaffUserId String Yes Agent account.
Status String Yes Status. specifies the instance status. valid values: free (idle), notReady (busy), rest (short break).
Reason String No Specifies the reason if the break state is set.

SetStaffStatusRspItem

Specifies the staff status response item.

Used by actions: SetStaffStatus.

Name Type Required Description
StaffUserId String No Agent account.
ErrorCode String No Error code. see the overall error code in the protocol.
ErrorMessage String No Error message.
Status String No Current status.
Reason String No Status if it is on break. specifies the reason.
PreviousStatus String No Previous status.
PreviousReason String No If the earlier status is on break, this is the reason.

SkillGroupInfoItem

Skill group information.

Used by actions: DescribeSkillGroupInfoList.

Name Type Description
SkillGroupId Integer Skill group id.
SkillGroupName String Skill group name.
Type String (Deprecated) type: im, tel, all (full media).
RoutePolicy String Session allocation policy.
UsingLastSeat Integer Whether the session is allocated to the last serviced agent first.
MaxConcurrency Integer Maximum concurrency number of single client service (default 1 for telephone type).
LastModifyTimestamp Integer Last modification time.
SkillGroupType Integer Skill group type 0-cell phone, 1-online, 3-audio, 4-video. .
Alias String Intra-Skill group line number.
RingAll Boolean Specifies whether to enable simultaneous ring.

SkillGroupItem

Skill group information.

Used by actions: DescribeStaffInfoList.

Name Type Description
SkillGroupId Integer Skill group id.
SkillGroupName String Skill group name.
Priority Integer Priority.
Type String Type: im, tel, all (full media).

StaffBuyInfo

Agent purchase information

Used by actions: DescribeCCCBuyInfoList.

Name Type Description
Num Integer Number of agents purchased.
BuyTime Integer Purchased timestamp.
EndTime Integer Deadline timestamp.
SipNum Integer Quantity of office telephones purchased.

StaffInfo

Agent Information with Skill Group Priority

Used by actions: DescribeStaffInfoList.

Name Type Description
Name String Agent name.
Mail String Agent email.
Phone String Agent phone number.
Nick String Agent nickname.
StaffNumber String Agent id.
RoleList Array of Integer Specifies the user role id list.
SkillGroupList Array of SkillGroupItem Affiliated skill group list.
LastModifyTimestamp Integer Last modification time.
ExtensionNumber String Agent extension number (starting with 1 to 8, 4 - 6 digits).
ForwardingConfig ForwardingConfig Call forwarding configuration.

StaffSkillGroupList

Bound skill group list for agents.

Used by actions: BindStaffSkillGroupList.

Name Type Required Description
SkillGroupId Integer Yes Skill group id.
Priority Integer No Priority of the agent in the skill group (1 is the highest, 5 is the lowest, 3 by default).

StaffStatus

Agent status.

Used by actions: DescribeStaffStatusHistory.

Name Type Required Description
Cursor String No Specifies the cursor used for querying in pagination scenarios.
Timestamp Integer No Status timestamp. Unix second-level timestamp.
Status String No Agent status free
SessionId String No Specifies the session Id for status association.
Reason String No Reason for break.
StaffEmail String No Agent email.
StaffNo String No Agent id.

StaffStatusExtra

Supplementary Information on Agent Status

Used by actions: DescribeStaffStatusMetrics.

Name Type Description
Type String IM - text
Direct String IN - inbound

StaffStatusMetrics

Agent status-related information

Used by actions: DescribeStaffStatusMetrics.

Name Type Description
Email String Agent email.
Status String Agent status free available
StatusExtra StaffStatusExtra Supplementary information on agent status.
OnlineDuration Integer Total online duration of the day.
FreeDuration Integer Total available duration of the day.
BusyDuration Integer Total busy duration of the day.
NotReadyDuration Integer Total not ready status duration of the day.
RestDuration Integer Total break duration of the day.
AfterCallWorkDuration Integer Adjust the total duration of after-call work for the day.
Reason String Reason for break.
ReserveRest Boolean Whether to reserve break status.
ReserveNotReady Boolean Whether to reserve not ready status.
UseMobileAccept Integer Cell phone answering pattern: 0 - off
UseMobileCallOut Boolean Cell phone outbound call switch.
LastOnlineTimestamp Integer Last online timestamp.
Note: this field may return null, indicating that no valid values can be obtained.
LastStatusTimestamp Integer Last status timestamp.
Note: this field may return null, indicating that no valid values can be obtained.
ClientInfo Array of ClientInfo Specifies the endpoint information for customer service logon.

TelCdrInfo

Phone call information

Used by actions: DescribeProtectedTelCdr, DescribeTelCdr.

Name Type Description
Caller String Caller number.
Callee String Called number.
Time Integer Call initiation timestamp, unix timestamp.
Direction Integer Call direction: 0 - inbound, 1 - outbound.
CallType Integer Call Type: 1. Voice outbound call 2. Voice Inbound call 3. Audio Inbound 5 Predictive Dialing Call 6. Internal Call between Staff
Duration Integer Call duration.
RecordURL String Recording information.
RecordId String Recording id.
SeatUser SeatUserInfo Agent information.
EndStatus Integer EndStatus corresponds one-to-one with EndStatusString. the specific enumeration is as follows:.

Scenario EndStatus EndStatusString status description.

Call in & out 1 ok normal call.

Inbound call 102 ivrGiveUp user give up during IVR period.

Inbound call 103 waitingGiveUp user give up in queue.

Inbound call 104 ringingGiveUp user gives up during ring.

Inbound call 105 noSeatOnline no agent online.

Inbound call 106 notWorkTime off hours.

Inbound call 107 ivrEnd IVR ends automatically (no manual intervention).

Inbound calls 100 blocklist (system side).

Outgoing call 108 restrictedCallee global outbound call risk number blocklist (system side).

Outgoing call 109 tooManyRequest outbound call frequency control block (system side).

Outbound call 110 restrictedArea outgoing call region block (system side).

Outgoing call 111 restrictedTime outbound call interception (system side).

Outgoing call 202 notAnswer callee unanswered.

Outgoing call 203 userReject callee reject hangup.

Outgoing call 204 powerOff callee shutdown.

Outgoing call 205 numberNotExist called nonexistent number.

Outbound call 206 busy callee busy.

Outbound call 207 outOfCredit callee in arrears.

208 operatorError operator channel exception.

Outgoing call 209 callerCancel call cancellation by the caller.

Outgoing call 210 notInService callee out of service area.

Phone call in & out 211 clientError agent client error.

Outgoing call 212 carrierBlocked isp blocked.

Outgoing call 213 callReminder note: call reminder.

Outbound call 215 numberInvalid called number invalid.

Outgoing call 216 callRestricted note: call restricted.

Outgoing call 217 calleeRestricted callee blocklist restricted.

Outbound call 218 areaRestricted callee area restricted.

Outbound call 219 promptCallForwarding note call transfer.

Outbound call 220 callerCancelWhileRing caller cancellation while ringing.

Outgoing call 221 callerCancelWithoutRing called number anomaly without ring.

Outgoing call 222 voiceMailReached voice mail hangup.

Audio inbound 501 callConflict VoIP user call conflict termination.

Audio dial-in 502 clientTimeout VoIP user client timeout.

Audio inbound 503 voipClientError VoIP client error.

For chinese description, see https://www.tencentcloud.com/zh/document/product/1229/71847.

For english details, see reference.
SkillGroup String Skill group name.
CallerLocation String Caller'S location.
IVRDuration Integer Time spent in ivr stage.
RingTimestamp Integer Ring timestamp. unix second-level timestamp.
AcceptTimestamp Integer Answer timestamp. unix second-level timestamp.
EndedTimestamp Integer End timestamp. unix second-level timestamp.
IVRKeyPressed Array of String IVR key information, e.g. ["1","2","3"].
HungUpSide String Hang-Up side, seat, user, system.
ServeParticipants Array of ServeParticipant Service participant list.
SkillGroupId Integer Skill group id.
EndStatusString String Refers to the EndStatus field.
StartTimestamp Integer Session start timestamp. unix second-level timestamp.
QueuedTimestamp Integer Queue entry time. unix second-level timestamp.
PostIVRKeyPressed Array of IVRKeyPressedElement Post-IVR key information (e.g. [{"key":"1","label":"very satisfied"}]).
QueuedSkillGroupId Integer Queue skill group id.
SessionId String Session id.
ProtectedCaller String Caller number protection id. effective when the number protection map feature is activated, and the caller field is empty.
ProtectedCallee String Called number protection id. effective when the number protection map feature is activated, and the callee field is empty.
UUI String Customer custom data. (user - to - user interface).
IVRKeyPressedEx Array of IVRKeyPressedElement IVR key information (e.g. [{"key":"1","label":"very satisfied"}]).
AsrUrl String Access to the asr text information address of the recording.
AsrStatus String ASRUrl status: complete.
Completed;.
Processing.
Generating.
NotExists.
No record (offline asr generation is not enabled or no package is available).
CustomRecordURL String Address of the third-party cos for transferring recording.
Remark String Remarks.
QueuedSkillGroupName String Queue skill group name.
VoicemailRecordURL Array of String Audio message recording url during call.
VoicemailAsrURL Array of String Text information address of asr audio message during a call.
AIAgentId Integer If it is a call related to intelligent agent, this is the intelligent agent ID.
AIAgentName String If it is a call related to intelligent agent, this is the intelligent agent name.
SysHangupReason Integer Reasons for system hang-up after connection, enumeration class.
SysHangupReasonString String Reason for hang-up after connect, text description.

TimeRange

Time range, 24-hour system, format: 09:00:00.

Used by actions: CreateAutoCalloutTask, CreatePredictiveDialingCampaign.

Name Type Required Description
StartTime String No Start time.
EndTime String No End time.

ToneWordInfo

Undertake filler word info.

Used by actions: CreateAICall.

Name Type Required Description
FirstSentenceTimeout Float No Specifies the timeout period for the first request in seconds.
ZHToneWords ZHToneWordsInfo No Undertakes a modal particle.

UploadAudioInfo

Upload Audio File Information

Used by actions: UploadIvrAudio.

Name Type Required Description
CustomFileName String Yes File alias (can be duplicated).
AudioUrl String Yes Audio file link (supports mp3 and wav formats, file size not exceeding 5mb).

UploadIvrAudioFailedInfo

Failed to upload audio file information

Used by actions: UploadIvrAudio.

Name Type Description
FileName String Filename.
FailedMsg String Reason for failure.

Variable

Variable.

Used by actions: CreateAIAgentCall, CreateAICall, CreateAutoCalloutTask, CreateIVRSession, CreatePredictiveDialingCampaign, UpdatePredictiveDialingCampaign.

Name Type Required Description
Key String Yes Variable name.
Value String Yes Variable value.

ZHToneWordsInfo

Undertake filler word.

Used by actions: CreateAICall.

Name Type Required Description
Neutral Array of String No Specifies the word list.
Positive Array of String No Positive word list.
Negative Array of String No Negative word list.

Topik sebelumnya: ControlAIConversationTopik selanjutnya: Error Codes

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan