tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-09-09 17:58:11

AudioFileInfo

Audio file review information

Used by actions: DescribeIvrAudioList, UploadIvrAudio.

Name Type Description
FileId Integer File ID
Note: This field may return null, indicating that no valid values can be obtained.
CustomFileName String File alias
Note: This field may return null, indicating that no valid values can be obtained.
AudioFileName String Filename
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Review status, 0-Not reviewed, 1-Approved, 2-Rejected
Note: This field may return null, indicating that no valid values can be obtained.

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 calls.
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, calling not started
1 Running
2 Completed: All calls in the task are completed
3 Ending: The task is due, but some calls are still not finished
4 Ended: Task terminated due to expiration
TaskId Integer Task ID.

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 in connection.
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.

Name Type Required Description
Callee String Yes Called number.
UUI String No Associate 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 Task ID
Note: This field may return null if no valid value is obtained.
Name String Task Name
Note: This field might return null if no valid values can be obtained.
Status Integer Task status 0 - Ready to start, 1 - In progress, 2 - Paused, 3 - Terminated, 4 - Completed.
Note: this field may return null, indicating that no valid values can be obtained.
StatusReason Integer Task status reasons 0 - Normal, 1 - Manually ended, 2 - Ended due to overtime.
Note: this field may return null, indicating that no valid values can be obtained.
CalleeCount Integer Number of called numbers.
Note: this field may return null, indicating that no valid values can be obtained.
FinishedCalleeCount Integer Number of completed calls.
Note: this field may return null, indicating that no valid values can be obtained.
Priority Integer Running priority of multiple tasks in the same application, from high to low 1 - 5.
Note: this field may return null, indicating that no valid values can be obtained.
SkillGroupId Integer ID of the used skill group of agents.
Note: this field may return null, indicating that no valid values can be obtained.

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 Key.
Note: this field may return null, indicating that no valid values can be obtained.
Label String Tag associated with key.
Note: this field may return null, indicating that no valid values can be obtained.

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.

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 Ringing
seatJoining waiting for the agent to answer
inProgress Ongoing
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 Total package.
CapacityRemain Integer Remaining package.
BuyTime Integer Purchased timestamp.
EndTime Integer End 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 End 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).
Note: this field may return null, indicating that no valid values can be obtained.

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.
Note: This field may return null, indicating that no valid value could be obtained.
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 seat
Note: This field may return null, indicating that no valid values can be obtained.
Role Integer No 1: Admin.
2: Quality inspector.
3: Ordinary agent.
else: Custom Role ID.
Note: This field may return null, indicating that no valid value could be obtained.

ServeParticipant

Participant information.

Used by actions: DescribeProtectedTelCdr, DescribeTelCdr.

Name Type Description
Mail String Agent email.
Note: This field may return null, indicating that no valid values can be obtained.
Phone String Agent Telephone
Note: This field may return null, indicating that no valid values can be obtained.
RingTimestamp Integer Ring timestamp. Unix second-level timestamp.
Note: This field may return null, indicating that no valid values can be obtained.
AcceptTimestamp Integer Answer timestamp. Unix second-level timestamp.
Note: This field may return null, indicating that no valid values can be obtained.
EndedTimestamp Integer End timestamp. Unix second-level timestamp.
Note: This field may return null, indicating that no valid values can be obtained.
RecordId String Recording ID, which can be used to index the recording on the agent side
Note: This field may return null, indicating that no valid values can be obtained.
Type String Participant type: "staffSeat", "outboundSeat", "staffPhoneSeat".
Note: This field may return null, indicating that no valid values can be obtained.
TransferFrom String Transfer Source Agent Information
Note: This field may return null, indicating that no valid values can be obtained.
TransferFromType String Transfer source participant type is consistent with the Type value.
Note: This field may return null, indicating that no valid values can be obtained.
TransferTo String Transfer Destination Agent Information
Note: This field may return null, indicating that no valid values can be obtained.
TransferToType String Transfer destination participant type is consistent with Type values.
Note: This field may return null, indicating that no valid values can be obtained.
SkillGroupId Integer Skill group ID.
Note: This field may return null, indicating that no valid values can be obtained.
EndStatusString String Ending status.
Note: This field may return null, indicating that no valid values can be obtained.
RecordURL String Recording URL.
Note: This field may return null, indicating that no valid values can be obtained.
Sequence Integer Participant sequence number, starting from 0.
Note: This field may return null, indicating that no valid values can be obtained.
StartTimestamp Integer Start timestamp. Unix second-level timestamp.
Note: This field may return null, indicating that no valid values can be obtained.
SkillGroupName String Skill Group name.
Note: This field may return null, indicating that no valid values can be obtained.
CustomRecordURL String Address of the third party COS for transferring recording.
Note: This field may return null, indicating that no valid values can be obtained.

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.
Note: this field may return null, indicating that no valid values can be obtained.
UsingLastSeat Integer Should the conversation allocation prioritize the last service seat?
Note: This field may return null, indicating that no valid values can be obtained.
MaxConcurrency Integer Maximum concurrency number of single client service (default 1 for telephone type).
Note: this field may return null, indicating that no valid values can be obtained.
LastModifyTimestamp Integer Last modification time.
Note: this field may return null, indicating that no valid values can be obtained.
SkillGroupType Integer Skill group type 0-phone, 1-online, 3-audio, 4-video.
Note: this field may return null, indicating that no valid values can be obtained.
Alias String Extension number within the skill group
Note: This field may return null, indicating that no valid values can be obtained.

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 End timestamp.
SipNum Integer Number of office telephones purchased.
Note: this field may return null, indicating that no valid values can be obtained.

StaffInfo

Agent Information with Skill Group Priority

Used by actions: DescribeStaffInfoList.

Name Type Description
Name String Agent name.
Note: This field may return null, indicating that no valid values can be obtained.
Mail String Agent email.
Phone String Agent's Telephone Number
Note: This field may return null, indicating that no valid values can be obtained.
Nick String Agent nickname.
Note: This field may return null, indicating that no valid values can be obtained.
StaffNumber String Agent ID
Note: This field may return null, indicating that no valid values can be obtained.
RoleId Integer User Role ID
SkillGroupList Array of SkillGroupItem Affiliated Skill Group List.
Note: this field may return null, indicating that no valid values can be obtained.
LastModifyTimestamp Integer Last modification time.
Note: this field may return null, indicating that no valid values can be obtained.

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 Total After Call Work duration of 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.
Note: this field may return null, indicating that no valid values can be obtained.
SeatUser SeatUserInfo Agent Information
EndStatus Integer EndStatus corresponds one-to-one with EndStatusString, specific enumerations are as follows:

Scenario EndStatus EndStatusString Status Description

Incoming & Outgoing Calls 1 ok Normal End

Incoming & Outgoing Calls 0 error System Error

Incoming Call 102 ivrGiveUp User Gave Up During IVR

Incoming Call 103 waitingGiveUp User Gave Up During Queue

Incoming Call 104 ringingGiveUp User Gave Up During Ringing

Incoming Call 105 noSeatOnline No Seat Online

Incoming Call 106 notWorkTime Non-Working Hours

Incoming Call 107 ivrEnd Ended Directly After IVR

Incoming Call 100 blackList Incoming blocklist

Outgoing Call 2 unconnected Unconnected

Outgoing Call 108 restrictedCallee Callee restricted due to high risk

Outgoing Call 109 tooManyRequest Frequency limit exceeded

Outgoing Call 110 restrictedArea Call to restricted area

Outgoing Call 111 restrictedTime Call time restricted

Outgoing Call 201 unknown Unknown status

Outgoing Call 202 notAnswer Missed call

Outgoing Call 203 userReject Reject/Hang Up

Outgoing Call 204 powerOff Shutting down

Outgoing Call 205 numberNotExist Disconnected Number

Outgoing Call 206 busy During the call

Outgoing Call 207 outOfCredit Overdue Payment

Outgoing Call 208 operatorError ISP Carrier Line Anomaly

Outgoing Call 209 callerCancel Caller Cancelled

Outgoing Call 210 notInService Out of Service Area

Incoming & Outgoing Calls 211 clientError Client Error
SkillGroup String Skill group name.
CallerLocation String Caller's location.
IVRDuration Integer Time spent in IVR stage.
Note: this field may return null, indicating that no valid values can be obtained.
RingTimestamp Integer Ring timestamp. UNIX second-level timestamp
Note: this field may return null, indicating that no valid values can be obtained.
AcceptTimestamp Integer Answer timestamp. UNIX second-Level timestamp
Note: this field may return null, indicating that no valid values can be obtained.
EndedTimestamp Integer End timestamp. UNIX second-level timestamp
Note: this field may return null, indicating that no valid values can be obtained.
IVRKeyPressed Array of String IVR key information, e.g. ["1","2","3"]
Note: this field may return null, indicating that no valid values can be obtained.
HungUpSide String Hanging Up Party seat Seat user Users system system
Note: This field may return null, indicating that no valid values can be obtained.
ServeParticipants Array of ServeParticipant List of Service Participants
Note: this field may return null, indicating that no valid values can be obtained.
SkillGroupId Integer Skill group ID.
Note: this field may return null, indicating that no valid values can be obtained.
EndStatusString String EndStatus corresponds one-to-one with EndStatusString, specific enumerations are as follows:

Scenario EndStatus EndStatusString Status Description

Incoming & Outgoing Calls 1 ok Normal End

Incoming & Outgoing Calls 0 error System Error

Incoming Call 102 ivrGiveUp User Gave Up During IVR

Incoming Call 103 waitingGiveUp User Gave Up During Queue

Incoming Call 104 ringingGiveUp User Gave Up During Ringing

Incoming Call 105 noSeatOnline No Seat Online

Incoming Call 106 notWorkTime Non-Working Hours

Incoming Call 107 ivrEnd Ended Directly After IVR

Incoming Call 100 blackList Incoming blocklist

Outgoing Call 2 unconnected Unconnected

Outgoing Call 108 restrictedCallee Callee restricted due to high risk

Outgoing Call 109 tooManyRequest Frequency limit exceeded

Outgoing Call 110 restrictedArea Call to restricted area

Outgoing Call 111 restrictedTime Call time restricted

Outgoing Call 201 unknown Unknown status

Outgoing Call 202 notAnswer Missed call

Outgoing Call 203 userReject Reject/Hang Up

Outgoing Call 204 powerOff Shutting down

Outgoing Call 205 numberNotExist Disconnected Number

Phone Call Out 206 busy In Call

Outgoing Call 207 outOfCredit Overdue Payment

Outgoing Call 208 operatorError ISP Carrier Line Anomaly

Outgoing Call 209 callerCancel Caller Cancelled

Outgoing Call 210 notInService Out of Service Area

Phone Call In & Out 211 clientError Client Error

Note: This field may return null, indicating that no valid values can be obtained.
StartTimestamp Integer Session start timestamp. UNIX second-level timestamp.
Note: This field may return null, indicating that no valid value can be obtained.
QueuedTimestamp Integer Queue entry time. Unix second-level timestamp.
Note: This field may return null, indicating that no valid value can be obtained.
PostIVRKeyPressed Array of IVRKeyPressedElement Post-IVR key information (e.g. [{"Key":"1","Label":"Very Satisfied"}])
Note: This field may return null, indicating that no valid value can be obtained.
QueuedSkillGroupId Integer Queue Skill Group ID.
Note: This field may return null, indicating that no valid value can be obtained.
SessionId String Session ID.
Note: This field may return null, indicating that no valid value can be obtained.
ProtectedCaller String Caller number protection ID. (Effective when the number protection map feature is activated, and the Caller field is empty).
Note: This field may return null, indicating that no valid values can be obtained.
ProtectedCallee String Called number protection ID (Effective when the number protection map feature is activated, and the Callee field is empty).
Note: This field may return null, indicating that no valid values can be obtained.
UUI String Customer custom data. (User-to-User Interface)
Note: This field may return null, indicating that no valid values can be obtained.
IVRKeyPressedEx Array of IVRKeyPressedElement IVR key information (e.g.?[{"Key":"1","Label":"highly satisfied"}])
Note: This field may return null, indicating that no valid values can be obtained.
AsrUrl String Access to the ASR text information address of the recording.
Note: This field may return null, indicating that no valid values can be obtained.
CustomRecordURL String Address of the third party COS for transferring recording.
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Remarks
Note: This field may return null, indicating that no valid values can be obtained.
QueuedSkillGroupName String Queue skill group name.
Note: This field may return null, indicating that no valid values can be obtained.
VoicemailRecordURL Array of String Audio message recording URL during call.
Note: This field may return null, indicating that no valid values can be obtained.
VoicemailAsrURL Array of String Text Information address of ASR audio message during a call.
Note: This field may return null, indicating that no valid values can be obtained.

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
Note: This field may return null, indicating that no valid values can be obtained.
FailedMsg String Reason for failure
Note: This field may return null, indicating that no valid values can be obtained.

Variable

Variable.

Used by actions: CreateAutoCalloutTask, CreateIVRSession.

Name Type Required Description
Key String Yes Variable name.
Value String Yes Variable value.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy