tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2025-02-13 18:05:54

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.

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 creation, call not started.
1 running.
2 completed: all calls in the task are completed.
3 ending: the task has expired, but there are still some calls not ended.
4 ended: task terminated due to expiration.
TaskId Integer .

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.

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.

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.

IVRKeyPressedElement

IVR Key Information.

Used by actions: DescribeProtectedTelCdr, 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.

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 | 1 - outbound | 2 - inbound and outbound.
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}.

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 | 1 - outbound.
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 | 1 - outbound.
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 | 1 - 400 inbound 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 | 1 - virtual business number | 2 - ISP number | 3 - 400 number.
CallType Integer Call type of the number, 1 - inbound | 2 - outbound | 3 - inbound and outbound.
BuyTime Integer Purchased timestamp.
EndTime Integer Deadline timestamp.
State Integer Number status, 1-normal | 2-suspended due to non-payment | 4-admin suspended | 5-suspended due to violation.

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, 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 Ending status.
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.

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.

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.
RoleId Integer User role id.
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).

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).

StaffStatusExtra

Supplementary Information on Agent Status

Used by actions: DescribeStaffStatusMetrics.

Name Type Description
Type String IM - text | tel - cell phone | all - full media.
Direct String IN - inbound | out - outbound.

StaffStatusMetrics

Agent status-related information

Used by actions: DescribeStaffStatusMetrics.

Name Type Description
Email String Agent email.
Status String Agent status free available | busy busy | rest on break | notready not ready | aftercallwork post-call adjustment | offline offline.
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 | 1 - only when offline | 2 - always.
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.

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.
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, with specific enumerations as follows:.

Scenario EndStatus EndStatusString Status description.

Inbound call & call 1 ok end properly.

Inbound call & call | 0 | error | system error.

Inbound call | 102 | ivrgiveup | user gives up during ivr.

Inbound call | 103 | waitinggiveup | user gives up during session queue.

Inbound call | 104 | ringinggiveup | user gives up during session ringing.

Inbound call | 105 | noseatonline | no agent online.

Inbound call 106 non - working hour non - working hour.

Inbound call 107 ivrend end directly after ivr.

Inbound call 100 blocklist call - in call - in blocklist.

Outgoing call 2 unconnected unconnected.

Outgoing call 108 restricted callee callee restricted due to high - risk.

Outgoing call 109 toomanyrequest overfrequency.

Outgoing call 110 restrictedarea outbound blind area.

Outgoing call 111 restrictedtime outbound time restriction.

Outgoing call 201 unknown unknown status.

Outgoing call 202 notanswer unanswered.

Outgoing call - 203 - userreject: reject call.

Outgoing call - 204 - poweroff: power off.

Outgoing call - 205 - numbernotexist: nonexistent number.

Outgoing call - 206 - busy: call in progress.

Outgoing call - 207 - outofcredit: arrears.

Outgoing call - 208 - operatorerror - ISP line exception.

Outgoing call - 209 - callercancel - caller cancellation.

Outgoing call - 210 - notinservice - not in service area.

Inbound and outgoing call - 211 - clienterror - client error.
Outgoing call - 212 - carrierblocked - ISP blocking.
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 EndStatus corresponds one-to-one with endstatusstring, with specific enumerations as follows:.

Scenario EndStatus EndStatusString Status description.

Inbound call & call 1 ok end properly.

Inbound call & call | 0 | error | system error.

Inbound call | 102 | ivrgiveup | user gives up during ivr.

Inbound call | 103 | waitinggiveup | user gives up during session queue.

Inbound call | 104 | ringinggiveup | user gives up during session ringing.

Inbound call | 105 | noseatonline | no agent online.

Inbound call 106 non - working hour non - working hour.

Inbound call 107 ivrend end directly after ivr.

Inbound call 100 blocklist call - in call - in blocklist.

Outgoing call 2 unconnected unconnected.

Outgoing call 108 restricted callee callee restricted due to high - risk.

Outgoing call 109 toomanyrequest overfrequency.

Outgoing call 110 restrictedarea outbound blind area.

Outgoing call 111 restrictedtime outbound time restriction.

Outgoing call 201 unknown unknown status.

Outgoing call 202 notanswer unanswered.

Outgoing call - 203 - userreject: reject call.

Outgoing call - 204 - poweroff: power off.

Outgoing call - 205 - numbernotexist: nonexistent number.

Outgoing call - 206 - busy: call in progress.

Outgoing call - 207 - outofcredit: arrears.

Outgoing call - 208 - operatorerror - ISP line exception.

Outgoing call - 209 - callercancel - caller cancellation.

Outgoing call - 210 - notinservice - not in service area.

Inbound and outgoing call - 211 - clienterror - client error.
Outgoing call - 212 - carrierblocked - ISP blocking.
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.

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.
Copyright © 2013-2025 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy