21)話術(shù)的啟用
功能說明:
通過此接口實(shí)現(xiàn)對(duì)話術(shù)的啟用。
更新說明: --
請(qǐng)求:
URL:http://{ip}/ai/ai2words/start
請(qǐng)求方法:POST
請(qǐng)求頭:必須帶上登錄時(shí)返回的Token
Auth: {登錄時(shí)返回的Token}
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
wordsId |
Integer |
是 |
話術(shù)的編號(hào) |
20 |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
Description |
String |
響應(yīng)描述 |
data |
JSON |
詳細(xì)的數(shù)據(jù) |
JSON請(qǐng)求實(shí)例:
{
"wordsId":20,
}
JSON響應(yīng)實(shí)例:
{
"errorCode": 0,
"description": "啟用成功",
"data": ""
}
22)指定話單修改意向等級(jí)
功能說明:
通過此接口實(shí)現(xiàn)對(duì)指定話單修改意向等級(jí)。
更新說明: --
請(qǐng)求:
URL:http://{ip}/ai/touchphone/updateGrade
請(qǐng)求方法:POST
請(qǐng)求頭:必須帶上登錄時(shí)返回的Token
Auth: {登錄時(shí)返回的Token}
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
grade |
Integer |
是 |
意向等級(jí) |
21 A類 22?B類 23?C類 24?D類 25?E類 26?F類 |
Id |
Integer |
是 |
編號(hào) |
話單編號(hào) |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
Description |
String |
響應(yīng)描述 |
data |
JSON |
詳細(xì)的數(shù)據(jù) |
JSON請(qǐng)求實(shí)例:
{
????"id": 1,
????"grade": 21
}
JSON響應(yīng)實(shí)例:
{
"errorCode": 0,
"description": "操作成功",
"data": ""
}
4、系統(tǒng)級(jí)回調(diào)消息
1)創(chuàng)建用戶成功后回調(diào)
功能說明:
通過此接口可以實(shí)現(xiàn)創(chuàng)建用戶成功后,主動(dòng)推送用戶信息到其他系統(tǒng)。
更新說明: --
請(qǐng)求方法:
POST
請(qǐng)求參數(shù):
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
action |
String |
是 |
動(dòng)作 |
NEW_USER_NOTIFY |
username |
String |
是 |
用戶賬戶 |
admin |
password |
String |
是 |
密碼 |
admin |
userId |
String |
是 |
用戶ID |
100 |
level |
Integer |
是 |
用戶等級(jí) |
0?超級(jí)管理員 1?普通用戶 2?代理用戶 |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
description |
String |
響應(yīng)描述 |
入?yún)SON實(shí)例:
{
????"action" : "NEW_USER_NOTIFY",
"username" : "admin",
"password" : "admin",
"userId" : 100,
"level" : 0
}
JSON響應(yīng)實(shí)例:
{
????"errorCode": 0,
????"description": "操作成功."
}
2)刪除用戶成功后回調(diào)
功能說明:
通過此接口可以實(shí)現(xiàn)刪除用戶成功后,主動(dòng)推送被刪除的用戶信息到其他系統(tǒng)。
更新說明: --
請(qǐng)求方法:
POST
請(qǐng)求參數(shù):
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
action |
String |
是 |
動(dòng)作 |
DELETE_USER_NOTIFY |
username |
String |
是 |
用戶賬戶 |
admin |
userId |
String |
是 |
用戶ID |
100 |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
description |
String |
響應(yīng)描述 |
入?yún)SON實(shí)例:
{
????"action" : "NEW_USER_NOTIFY",
"username" : "admin",
"userId" : 100
}
JSON響應(yīng)實(shí)例:
{
????"errorCode": 0,
????"description": "操作成功."
}
3)語(yǔ)音驗(yàn)證碼撥打電話完成主動(dòng)回調(diào)(語(yǔ)音驗(yàn)證碼功能聯(lián)系管理員授權(quán))
功能說明:
通過此接口可以實(shí)現(xiàn)撥打電話播放語(yǔ)音驗(yàn)證碼完成后的回調(diào)。
更新說明: --
請(qǐng)求:
URL:用戶配置的回調(diào)地址?
請(qǐng)求方法:
POST
請(qǐng)求參數(shù):
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
action |
String |
是 |
動(dòng)作 |
DAIL_FINISH_NOTIFY |
targetPhone |
String |
是 |
被叫號(hào)碼 |
13666669999 |
sourcePhone |
String |
是 |
主叫號(hào)碼 |
13622225555 |
busiId |
String |
是 |
業(yè)務(wù)ID |
100 |
UUID |
String |
是 |
唯一ID |
AAAA-BBBB |
touchPhoneId |
Integer |
是 |
通過唯一ID |
通過此ID可以查詢對(duì)應(yīng)的通話記錄 |
conversationTime |
Integer |
是 |
通話時(shí)長(zhǎng) |
單位秒 |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
description |
String |
響應(yīng)描述 |
入?yún)SON實(shí)例:
{
"action" : "DAIL_FINISH_NOTIFY", ???
"targetPhone" : "13900001111",
"sourcePhone" : "13022221111",
"busiId" : "1000",
"UUID" : "AAAA-BBBB-CCCC-DDDD",
"touchPhoneId" : 3,
"conversationTime" : 39
}
a
JSON響應(yīng)實(shí)例:
{
????"errorCode": 0,
????"description": "操作成功."
}
5、用戶級(jí)回調(diào)消息
1)電話撥打完成后的回調(diào)
功能說明:
通過此接口可以實(shí)現(xiàn)機(jī)器人和用戶通話完成后,主動(dòng)推送撥打詳情給第三方系統(tǒng)。
更新說明: --
請(qǐng)求方法:
POST
請(qǐng)求參數(shù):
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
action |
String |
是 |
動(dòng)作 |
USER_PHONE_FINISH_NOTIFY |
Id |
Integer |
是 |
編號(hào) |
1 |
phone |
String |
是 |
手機(jī)號(hào)碼 |
13600001234 |
name |
String |
是 |
名稱 |
張三 |
source |
String |
是 |
來源 |
廣告客戶 |
intention |
Integer |
是 |
接聽狀態(tài) |
2?已接聽 9未接聽掛斷/關(guān)機(jī)/欠費(fèi) 10無人接聽 |
grade |
Integer |
否 |
客戶等級(jí) |
21 A類(較強(qiáng)) 22 B類(一般) 23 C類(很少) 24 D類(需篩選) 25 E類(需再次跟進(jìn)) 26 F類(無需跟進(jìn)) |
focus |
String |
否 |
客戶關(guān)注點(diǎn) |
利息多少 |
uploadtime |
Long |
是 |
上傳時(shí)間 |
1544436127000 |
dailtime |
Long |
是 |
撥打時(shí)間 |
1544436127000 |
conversationtime |
Integer |
否 |
通話時(shí)長(zhǎng),單位:秒 |
30 |
talkcount |
Integer |
否 |
通話輪次 |
3 |
touchPhoneId |
Integer |
是 |
通過唯一ID |
通過此ID可以查詢對(duì)應(yīng)的通話記錄 |
sex |
String |
否 |
性別 |
男 |
company |
String |
否 |
公司 |
XXX公司 |
sort |
String |
否 |
分類 |
XXX分類 |
address |
String |
否 |
地址 |
XXX 地址 |
remark1 |
String |
否 |
備注1 |
備注1 |
remark2 |
String |
否 |
備注2 |
備注2 |
remark3 |
String |
否 |
備注3 |
備注3 |
remark4 |
String |
否 |
備注4 |
備注4 |
remark5 |
String |
否 |
備注5 |
備注5 |
wordsId |
Integer |
否 |
話術(shù)ID |
話術(shù)ID |
wordsName |
String |
否 |
話術(shù)的名稱 |
話術(shù)的名稱 |
userId |
Integer |
是 |
用戶ID |
用戶ID |
taskId |
Integer |
是 |
任務(wù)ID |
默認(rèn)0?快捷撥打任務(wù)編號(hào) 其它為創(chuàng)建的任務(wù)的編號(hào) |
chatList |
Array |
否 |
對(duì)話記錄 |
對(duì)話格式見案例 |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
description |
String |
響應(yīng)描述 |
入?yún)SON實(shí)例:
{
????"action" : "USER_PHONE_FINISH_NOTIFY",
"phone" : "13699998888",
"name" : "張三",
中間省略?
"userId" : 100,
"taskId" : 23,
"chatList" : [{
"id": 15676,
"inserttime": 1544436127000,
"khcontent": "喂,您好?。ㄍnD兩秒)您好,這邊是可以大量外呼的銷售機(jī)器人,您有興趣了解下嗎?",
"khtype": 0,
"khvoicepath": "RDovdm9pY2VGaWxlL0FJMnFpdGFjaGFucGludHVpZ3VhbmctamlxaXJlbnppeGlhby0xODkyOF8yMDE4MTExMjE0MTMwM181NDkvdXBsb2FkLTIwMTgwOTI5MTQyMzA0XzQ0Ni53YXY=",
"phone": "900113668161682",
"touchphoneid": 4744,
"uuid": "058f1e0f-bc4c-4ee7-8256-377ce02f03d1"
}, {
"id": 15677,
"inserttime": 1544436131000,
"khcontent": "啊",
"khtype": 1,
"khvoicepath": "RDovcmVjb3JkLzIwMTgtMTItMTAvOTAwMTEzNjY4MTYxNjgyXzA1OGYxZTBmLWJjNGMtNGVlNy04MjU2LTM3N2NlMDJmMDNkMV8xLndhdg==",
"phone": "900113668161682",
"touchphoneid": 4744,
"uuid": "058f1e0f-bc4c-4ee7-8256-377ce02f03d1"
}]
}
JSON響應(yīng)實(shí)例:
{
????"errorCode": 0,
????"description": "操作成功."
}
2)任務(wù)自動(dòng)撥打完成后的回調(diào)
功能說明:
通過此接口可以實(shí)現(xiàn)機(jī)器人的任務(wù)自動(dòng)撥打完成后,主動(dòng)推送撥打詳情給第三方系統(tǒng)。
更新說明: --
請(qǐng)求方法:
POST
請(qǐng)求參數(shù):
參數(shù)名 |
類型 |
是否必須 |
描述 |
實(shí)例 |
action |
String |
是 |
動(dòng)作 |
USER_TASK_FINISH_NOTIFY |
taskId |
Integer |
是 |
任務(wù)編號(hào) |
默認(rèn)0?快捷撥打任務(wù)編號(hào) 其它為創(chuàng)建的任務(wù)的編號(hào) |
taskName |
String |
是 |
任務(wù)名稱 |
任務(wù)名稱 |
userId |
Integer |
是 |
用戶ID |
用戶ID |
taskId |
Integer |
是 |
任務(wù)ID |
默認(rèn)0?快捷撥打任務(wù)編號(hào) 其它為創(chuàng)建的任務(wù)的編號(hào) |
status |
Integer |
是 |
任務(wù)狀態(tài) |
10已完成 |
響應(yīng):
參數(shù)名 |
類型 |
描述 |
errorCode |
Integer |
響應(yīng)碼 ?0 成功 |
description |
String |
響應(yīng)描述 |
入?yún)SON實(shí)例:
{
????"action" : "?USER_TASK_FINISH_NOTIFY",
"taskId" : 1,
"taskName" : "快捷外呼",
"userId" : 100,
"taskId" : 23
}
JSON響應(yīng)實(shí)例:
{
????"errorCode": 0,
????"description": "操作成功."
}
6、測(cè)試工具PostMan
1)登錄測(cè)試
請(qǐng)求模式選擇:POST
Body標(biāo)簽頁(yè)下面輸入請(qǐng)求內(nèi)容,見上圖。
登錄成功,返回:
1)語(yǔ)音驗(yàn)證碼播放測(cè)試
請(qǐng)求頭輸入認(rèn)證KEY和VALUE,見上圖
7、FAQ
1、此文檔是系統(tǒng)所有接口的全部么?
答:不是的,整套系統(tǒng)都是采用的RESTful調(diào)用,也就是任何功能都有RESTful接口,但提供商沒有將所有接口文檔化。沒有文檔化的接口,根據(jù)對(duì)接端客戶的需求再進(jìn)行二次文檔化。客戶購(gòu)買系統(tǒng)后,也可以通過谷歌瀏覽器按F12進(jìn)入調(diào)式模式的方式查詢每個(gè)功能的RESTful的接口詳情。
文章來源:http://www.zghlxwxcb.cn/news/detail-766733.html
文章來源地址http://www.zghlxwxcb.cn/news/detail-766733.html
到了這里,關(guān)于接上文AI電銷機(jī)器人-智能AI機(jī)器人源碼,電話機(jī)器人源碼和系統(tǒng)部署運(yùn)行環(huán)境freeswitch的文章就介紹完了。如果您還想了解更多內(nèi)容,請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!