派前预约外呼接口文档
外呼任务接收接口
接口地址
方式：HTTP post请求
1.测试环境: http: 10.202.112.189 /ins/ivr/newTask.pub或者
3.生产环境: 暂无
研发人员：孙楚昌
字段 字段名称 数据类型 备注
phoneNumber 外呼号码 String（必填）
content 外呼内容 String（必填） 格式：运单尾号|派件地址
startTime 外呼开始时间 Date 空值
stopTime 外呼截止时间 Date 空值
type 任务类型 String（必填） SGS_SEND_APPOINTMENT
businessId 交易流水号(KAFKA接口用) String 空值
返回：response 含 returnFlag（成功或失败标识）returnMessage（成功或失败原因）和 taskId（唯一标识）
成功返回例子：
{
“returnFlag”: “0”,
“returnMessage”：“成功”,
“taskId”：“0001”
}
失败返回例子：
{
“returnFlag”: “1”,
“returnMessage”：“电话号码含有非数字字符”,
“taskId”：“1”
}
失败原因列表：
外呼结束时间不能小于外呼开始时间
开始时间不能小于当前时间
内容不能为空
电弧号码不能为空
电话号码含有非数字字符
电话号码长度校验失败
外呼内容字数长度校验失败
外呼号码已在黑名单
IP不在白名单
任务类型不存在
其他原因
任务反馈:
接口方式：推送kafka
Kafka:INS_CORE_RESPONSE 集群：other2
研发人员：邓朝贵
字段 字段名称 数据类型 备注
taskId 任务ID String
phoneNumber 客户号码 String
status 外呼状态（0：未外呼,1：已外呼） int
beginTime 实际外呼开始时间 String 内容格式为:”2017-01-01 18:18:18”
connectTime 实际外呼接通时间 String 此字段为空的话，代表已外呼客户未接听
finishTime 实际外呼结束时间 String
talkTimes 接通时长 int connectTime- finishTime
keyRecord 客户按键 String
systemCode 系统编码 String
message 备注 String 任务执行备注
businessId 交易流水号 String
话单推送申请输入参数说明:
方式：HTTP post请求
1.测试环境: http: 10.202.112.189 /ins/ivr/comserviceSave.pub
service name 固定填写 “SFIVREndRequest”
参数 是否必须 类型 描述
serviceName 业务名称 string SFIVREndRequest
messageId 是 string 申请流水号
callId 是 string 呼叫中心callId (保证唯一)
calledNum 是 string 被叫电话
calledDisplayNum 是 string 被叫显示号码
calledStreamNo 是 string 被叫话单流水号
callStartTime 是 string 开始呼叫时间
callRingTime 是 string 振铃时长
callAnswerTime 否 string 被叫应答时间
callEndTime 是 string 被叫通话结束时间
calledDuration 是 string 被叫通话时长
dtmfKey 否 string 按键收号
calledRelCause 是 string 被叫结束原因（合并通话状态原因）
1、正常接通
2、呼叫遇忙
3、用户不在服务区
4、用户无应答
5、用户关机
6、空号
7、停机
8、号码过期
9、主叫应答，被叫应答前挂机
99、其他
20：主动取消呼叫
calledOriRescode 否 string 被叫结束的原始原因值（信令层面）
calledRelReason 否 string 被叫释放Reason
请求示例：
{
“body”: {
“callId”: “C20170613144349AC102A3D0238114903”,
“calledNum”: “180****5543”,
“calledDisplayNumber”: “9533885”,
“calledStreamNo”: “I20170613144408034457AC102A3D03348254”,
“callStartTime”: “20170613144401”,
“callRingTime”: “10”,
“callAnswerTime”: “7”,
“callEndTime”: “20170613144408”,
“dtmfKey”: “1”,
“calledRelCause”: “1”,
“calledOriRescode”: “0”,
“calledRelReason”: “CALL_CALLED_HANG_UP”,
},
“header”: {
“serviceName”: “SFIVREndRequest”,
“messageId”: “0000000000111111547984564687111”
}
}
1.2.1 返回参数说明
参数 是否必须 类型 描述
result 是 int 返回状态码 详见附录
messageId 是 string 呼叫申请流水号，唯一
reason 否 string 原因描述
serviceName 是 string 派前外呼呼叫申请
成功返回示例：
{
“body”: {
“result”: “0000”,
“reason”: “succ”
},
“header”: {
“serviceName”: “SFIVREndResponse”,
“messageId”: “0000000000111111547984564687111”
}
}
失败返回示例：
{
“header”:
{
“serviceName”: “SFIVREndResponse”,
“messageId”: “0000000000111111547984564687”
},
“body”:
{
“result”: “9999”,
“reason”: "接收错误 "
}
话单推送:
推送方式: http协议post请求调用山东通服接口
测试url：http:ip:port/CTDNOTICE/CTD?mac=SHA256(SHA256(json)+key)
Key: 山东通服提供
Ip : 山东通服提供
Port : 山东通服提供
其中json为请求报文（需要去掉空格，制表符，换行符）。
参数 是否必须 类型 描述
serviceName 是 string SFIVRRequest，派前外呼呼叫申请
messageId 是 string 呼叫申请流水号，唯一
displayNum 是 string 呼叫显示号码(9533885)
calledNum 是 string 被叫电话
numCode 是 string 订单后四位尾号
mediaContent 是 string 收货地址
调用接口示例:
{
“header”: {
“serviceName”: “SFIVRRequest”,
“messageId”: “0000000000111111547984564687111”,
},
“body”: {
“displayNum”: “9533885”,
“calledNum”: “180****5543”,
“mediaContent”: “asd”,
“numCode”: “1234”
}
}
1.2.2 返回参数说明
参数 是否必须 类型 描述
result 是 int 返回状态码 详见附录
messageId 是 string 呼叫申请流水号，唯一
reason 否 string 原因描述
serviceName 是 string 派前外呼呼叫申请
话单推送成功返回示例：
{
“body”: {
“result”: “0000”,
“reason”: “succ”
},
“header”: {
“serviceName”: “SFIVRResponse”,
“messageId”: “0000000000111111547984564687111”
}
}
话单推送失败返回示例：
{
“body”: {
“result”: “0001”,
“reason”: “mac is error!”
},
“header”: {
“serviceName”: “SFIVRResponse”,
“messageId”: “0000000000111111547984564687111”
}
}