派前預約外呼介面文件
外呼任務接收介面
介面地址
方式：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”
}
}