事件消息格式

所有事件公共字段

下列三个字段为所有类型事件的公共字段。

字段

名称

示例值

eventTime

事件时间

2021-04-14T02:34:00.447Z(格林威治时间)

eventType

事件类型

本节介绍的所有事件类型中任意一种。

instanceId

呼叫中心实例ID

report-test-2

坐席类事件

下面两个字段为所有坐席类事件的公共字段

字段

名称

示例值

skillGroupIds

签入技能组ID列表

skg-default@report-test-2,skillgroup@report-test-2

agentId

坐席ID

test@report-test-2

  • AgentCheckIn

字段

名称

示例值

skillLevels

技能组等级列表

[{"skillLevel":5,"skillGroupId":"skg-default@ccc-staging-2"},{"skillLevel":5,"skillGroupId":"vvip@ccc-staging-2"}]

  • AgentReady

字段

名称

示例值

outboundScenario

是否为仅外呼模式

0、1。

  • AgentDialing

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

channelId

通话通道ID

19aafd79-ba0c-4102-8e58-9a699d4e5811

callType

呼叫类型

INTERNAL(内部通话)、

INBOUND(呼入)、

OUTBOUND(呼出)、

CONFERENCE(会议)、

BACK2BACK(双呼)、

PREDICTIVE(预测式外呼)、

CONSULTANT(咨询)、

MONITOR(监听)、

COACH(辅导)、

BARGE(强插)、

INTERCEPT(强拆)。

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

BLIND_TRANSFER(直接转接)、

ATTENDED_TRANSFER(咨询转接)、

CONSULTED(咨询)、

MONITORING(监听中)、

COACHING(辅导中)、

INTERCEPTING(强拆中)、

INTERCEPTED(强拆完成)、

BARGING(强插中)、

CONFERENCE(会议)。

  • AgentRinging

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

channelId

通话通道ID

19aafd79-ba0c-4102-8e58-9a699d4e5811

callType

呼叫类型

同上。

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

同上。

  • AgentTalk

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

channelId

通话通道ID

19aafd79-ba0c-4102-8e58-9a699d4e5811

callType

呼叫类型

同上。

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

同上。

  • AgentRelease

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

channelId

通话通道ID

19aafd79-ba0c-4102-8e58-9a699d4e5811

callType

呼叫类型

同上。

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

同上。

  • AgentBreak

字段

名称

示例值

breakCode

小休事件代码

功能开发中,即将发布。

  • AgentCheckOut

无特有字段,继承公有字段。

  • SatisfactionSurveyOffer

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

skillGroupId

通话相关的技能组ID

skg-default@report-test-2

surveyChannel

调查发送方式

IVR(语音满意度)、

SMS(短信满意度)。

callType

呼叫类型

同上。

caller

主叫号码

13888888888

callee

被叫号码

01112345678

  • SatisfactionSurveyResponse

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

skillGroupId

通话相关的技能组ID

skg-default@report-test-2

surveyChannel

调查发送方式

同上。

rating

满意度评级

1

userInput

按键记录

功能开发中,即将发布。

话务类事件

下面八个字段为所有话务类事件的公共字段

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

channelId

通话通道ID

19aafd79-ba0c-4102-8e58-9a699d4e5811

callType

呼叫类型

同上。

caller

主叫号码

13888888888

callee

被叫号码

01112345678

broker

中间号码

40088888888

additionalBroker

附加中间号码,如果该参数存在,则呼叫callee时使用该参数指定的号码。

40068888888

contactFlowId

联系流ID

3a094311-1c41-4d25-9894-635f7562ea07

  • Dialing

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

同上。

  • Ringing

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

destination

目的方

80002301

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

同上。

  • Established

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

scenario

拨号场景

同上。

  • Released

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

releaseReason

挂断原因

挂断原因来源于SIP信令中,如果不熟悉SIP返回码,可以咨询云呼售后技术支持钉钉号。示例值:200 - Okay。

scenario

拨号场景

同上。

  • Held

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

heldChannelId

被保持的通道ID

ch-customer-01112345678-1010-1618315850388-job-103826849851777024

  • Retrieved

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

retrievedChannelId

被取回的通道ID

ch-customer-01112345678-1010-1618315850388-job-103826849851777024

  • Muted(正在开发中,即将发布。)

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

mutedChannelId

被静音的通道ID

功能开发中,即将发布。

  • Unmuted(正在开发中,即将发布。)

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

unmutedChannelId

被取消静音的通道ID

功能开发中,即将发布。

  • BlindTransfer

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

originator

转接发起方

80001878

destination

转接目的方

80002301

  • AttendedTransfer

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

originator

转接发起方

80001878

destination

转接目的方

80002301

  • InitiateConsultant

字段

名称

示例值

agentId

坐席ID(咨询发起方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被咨询方

zhangli@report-test-2

  • StartConsultant

字段

名称

示例值

agentId

坐席ID(咨询发起方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被咨询方

zhangli@report-test-2

  • StopConsultant

字段

名称

示例值

agentId

坐席ID(咨询发起方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被咨询方

zhangli@report-test-2

  • Threeway

功能开发中,即将发布。

  • StartConference

功能开发中,即将发布。

  • StopConference

功能开发中,即将发布。

  • Route2IVR

无特有字段,继承公有字段。

  • Abandoned

字段

名称

示例值

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

abandonPhase

放弃阶段

IVR(IVR交互阶段)、

Queuing(排队阶段)、

Ringing(坐席振铃阶段)。

  • Enqueue

字段

名称

示例值

queueType

队列类型

SkillGroup(技能组)、

Agent(坐席)。

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

  • QueueingTimeout

字段

名称

示例值

queueType

队列类型

SkillGroup(技能组)、

Agent(坐席)。

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

  • AssignAgent

字段

名称

示例值

queueType

队列类型

SkillGroup(技能组)、

Agent(坐席)。

agentId

坐席ID

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

  • StartMonitor

字段

名称

示例值

agentId

坐席ID(被监听方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

监听方

zhangli@report-test-2

  • StopMonitor

字段

名称

示例值

agentId

坐席ID(被监听方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

监听方

zhangli@report-test-2

  • StartCoach

字段

名称

示例值

agentId

坐席ID(辅导方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被辅导方

zhangli@report-test-2

  • StopCoach

字段

名称

示例值

agentId

坐席ID(辅导方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被辅导方

zhangli@report-test-2

  • BargeIn

字段

名称

示例值

agentId

坐席ID(强插方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被强插方

zhangli@report-test-2

  • Intercept

字段

名称

示例值

agentId

坐席ID(强拆方)

agent@report-test-2

skillGroupId

技能组ID

skg-default@report-test-2

counterparty

被强拆方

zhangli@report-test-2

  • TextStream

字段

名称

示例值

skillGroupId

技能组ID

skg-default@report-test-2

agentId

坐席ID

nihao nihao agent@report-test-2

channelType

声道类型

agent(坐席)、

customer(客户)。

channelName

声道名称

ch-user-1018-80002301-1618366018463-job-a6370a73-4a4a-4389-b884-c89e4cef27fe

text

ASR识别结果

你好,hello。

finished

一句话是否结束

0、1。

beginTime

对话开始时间

2021-04-14T01:56:55Z(格林威治时间)

beginOffsetMS

句子开始时间相对于会话开始时间的偏移量,单位是毫秒

1380

endOffsetMS

当前已经处理完成的语音时间相对于会话开始时间的偏移量,单位是毫秒

2370

extraInfo

ASR识别的其他信息

speechRate=89;emotionIndex=0

  • RecordingReady

字段

名称

示例值

startTime

开始时间。 呼出场景下,开始时间指开始拨号时间;呼入场景下,开始时间指电话进入IVR时间;双呼场景下,开始时间指开始拨号时间。

2021-04-14T01:56:55Z(格林威治时间)

endTime

结束时间

2021-04-14T01:57:25Z(格林威治时间)

agentIds

座席ID列表

agent@report-test-2

fileName

文件名称

job-d0103c3e-db21-4075-9292-f88b1f978b24.wav

downloadURL

下载地址

OSS的下载链接。

  • DualTrackRecordingReady

字段

名称

示例值

startTime

开始时间。 呼出场景下,开始时间指开始拨号时间;呼入场景下,开始时间指电话进入IVR时间;双呼场景下,开始时间指开始拨号时间。

2021-04-14T01:56:55Z(格林威治时间)

endTime

结束时间

2021-04-14T01:57:25Z(格林威治时间)

agentIds

座席ID列表

agent@report-test-2

fileName

文件名称

job-d0103c3e-db21-4075-9292-f88b1f978b24.wav

downloadURL

下载地址

OSS的下载链接。

  • CDRReady

字段

名称

示例值

startTime

开始时间。 呼出场景下,开始时间指开始拨号时间;呼入场景下,开始时间指电话进入IVR时间;双呼场景下,开始时间指开始拨号时间。

2021-04-14T01:56:55Z(格林威治时间)

establishedTime

通话建立时间。双呼场景下,通话建立和结束时间都是指第一通电话的时间。如果电话未接通,则此参数为空。

2021-04-14T01:56:55Z(格林威治时间)

endTime

结束时间

2021-04-14T01:57:25Z(格林威治时间)

dispositionCode

挂机代码

Success(正常)、

AbandonedInQueue(排队放弃)、

AbandonedRing(振铃放弃)、

AbandonedInContactFlow(IVR中放弃)、

NoAnswer(未接通)、

Reject(客户拒接)。

agentIds

座席ID列表

agent@report-test-2

skillGroupIds

技能组ID列表

skg-default@report-test-2

IVR轨迹类事件

  • IvrTracking

字段

名称

示例值

contactId

话务ID

job-f8e9639a-81b8-4740-8af7-c13cc1553919

channelId

通话通道ID

19aafd79-ba0c-4102-8e58-9a699d4e5811

caller

主叫号码

13888888888

callee

被叫号码

01112345678

flowId

IVR流程ID

3a094311-1c41-4d25-9894-635f7562ea07

flowType

IVR流程类型

MAIN_FLOW(主流程)、

SUB_FLOW(子流程)、

SURVEY_FLOW(满意度流程)。

nodeId

IVR节点ID

dda23597

nodeName

IVR节点名称,由用户在配置IVR模块时设置,关联“模块名称”属性。

转人工模块

nodeType

IVR节点类型

PLAY_SAY(放音)、

TRANSFER_TO_AGENT(转人工)、

FORWARD_TO_OUTSIDE_NUMBER(转外部号码)、

GATHER_INPUT(收号)、

BRANCH(分支)、

HANGUP(结束)、

FUNCTION_COMPUTE(函数计算)、

VOICE_NAVIGATOR(智能语音导航)。

nodeExitCode

IVR节点退出时触发的事件

Success(成功)、

Failure(失败)、

Hangup(客户挂机)、

Timeout(队列/函数/收号等超时)、

Overflow(队列溢出)、

Default(逻辑判断缺省出口)、

Branch-A/B/C(各个逻辑判断出口)。

nextNodeId

下一个要执行的节点ID

58d5ae90

nodeProperties

IVR节点属性

内容与IVR节点类型有关,详情见下表的补充内容。

nodeVariables

IVR节点在运行时设置的变量

内容与IVR节点类型有关,详情见下表的补充内容。

nodeAction

节点动作

ENTER(进入)、

LEAVE(离开)。

channelVariables

随路数据

补充:下表列出了在不同的nodeType类型中nodeProperties和nodeVariables字段的示例值。大部分的nodeProperties变量可以通过IVR模块界面设置,nodeProperties变量是静态的,在模块编辑完成时就已经确定,而nodeVariables是动态的,它是在运行过程中产生的变量。

nodeType

nodeProperties

nodeVariables

PLAY_SAY

{
 "say": "正在转人工"
}

say:文字转语音的内容。

{
 "play": "aaa.wav"
}

play:使用的音频文件。

TRANSFER_TO_AGENT

{
 "queuePriority": 5,
 "agentGreetingSay": "你好,工号 ${agentDisplayName} 为您服务",
 "routingStrategy": "MOST_IDLE",
 "positionHintsSay": "请耐心等候,当前 ${queuePosition} 位",
 "queuingOverflowThreshold": "300",
 "say": "现在播放时区${sys.dateTime.zone} 播放星期 ${sys.dateTime.dayOfWeek} ",
 "periodicAnnouncementIntervalSeconds": 20,
 "queuingTimeoutSeconds": "600",
 "skillGroupId": "liutong@report-test-2",
 "routingStrategyParams": "{}"
}

queuePriority:优先级。

agentGreetingSay:坐席接起前播报内容。

routingStrategy:转接策略。

positionHintsSay:当前排队位置播报内容。

queuingOverflowThreshold:电话进入队列时,如果当前排队的电话个数超过指定的阈值,则直接溢出。

say:排队播报内容。

periodicAnnouncementIntervalSeconds:轮播时长间隔(单位:秒)。

queuingTimeoutSeconds:排队超时时间。

skillGroupId:转接技能组。

routingStrategyParams:转接策略参数。

{
 "agentChannelId": "ch-user-1866-80002300-1619332030313-job-7608da25-21cc-45fe-a0ce-217fd7495806"
}

agentChannelId:分配到的坐席的ChannelId。

FORWARD_TO_OUTSIDE_NUMBER

{
 "caller": "01112345678",
 "callee": "1013"
}

caller:转外线的主叫号码。

callee:转外线的被叫号码。

GATHER_INPUT

{
 "maxTries": 5,
 "regex": "",
 "minLength": 1,
 "say": "请输入分支,按1转人工,按2转坐席。",
 "terminator": "#",
 "maxLength": 1,
 "timeout": 10
}

maxTries:最大尝试次数。

regex:按键正则校验。

minLength:按键最小长度。

say:文字转语音内容。

terminator:终止符。

maxLength:按键最大长度。

timeout:用户按键输入超时时间。

{
 "digits": "1"
}

digits:输入。

BRANCH

{
 "expression": "'1'=='1'"
}

expression:输入匹配到的分支表达式。

HANGUP

FUNCTION_COMPUTE

{
 "functionName": "HelloWorld",
 "parameters": "[{\"key\":\"name\",\"value\":\"alice\"},{\"key\":\"age\",\"value\":\"18\"}]"
}

functionName:调用的函数名称。

parameters:调用的函数的参数。

{
 "responseBody": "{\"name\":\"Dear Sir undefined\",\"greeting\":\"Welcome!\"}",
 "requestParams": "[{\"key\":\"name\",\"value\":\"2021\"}]",
 "responseCode": 200
}

responseBody:函数响应结果。

requestParams:函数请求参数。

reponseCode:函数响应码。

VOICE_NAVIGATOR

功能开发中,即将发布。

功能开发中,即将发布。