<small id="aimcq"></small>
  • # 智能外呼

    # 1、接口聲明

    業務流程圖:
    圖片

    # 2、接口調用

    # 2.1、校驗賬號

    接口說明:

    接口類型:主動調用接口

    接口作用:校驗登錄賬號是否與appid符合。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/check_login_name

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    email 字符串 登錄郵箱賬號

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    check_result 整形 校驗結果:1 校驗通過,0:校驗不通過
    reason 字符串 校驗失敗原因

    請求示例:

    https://icall.sobot.com/api/icall/5/task/check_login_name?appid=XXXX&signature=XXXX&email=XXXX@sobot.com

    返回示例:

    {
        "check_result": 1,
        "ret_msg": "校驗成功",
        "ret_code": "000000"
    }
    

    # 2.2、查詢模板

    接口說明:

    接口類型:主動調用接口

    接口作用:查詢智能外呼系統中可用的模板,用于接口創建任務。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_template

    請求參數:

    參數 類型 必填 名稱
    appid 字符串 智齒分配
    signature 字符串 智齒分配

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    data 對象 返回結果 詳見下文

    返回data:

    參數 類型 必填 名稱
    templateid 字符串 模板id
    template_name 字符串 模板名稱
    content 字符串 首節點話術
    record 字符串 首節點錄音地址或tts語音,多個以英文逗號隔開。

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_template?appid=XXXXXX&signature=XXXXXX

    返回示例:

    {
        "data": [
            {
                "template_name": "內容輸出測試",
                "record": "http://sobot-test.oss-cn-beijing.aliyuncs.com/call/ai/TTS/4401f750a3eef4c41805df1341218166.mp3",
                "templateid": "6a9b98410bd44470ae4660275c14792f",
                "content": "你好,請問您要賣車嗎?"
            },
            {
                "template_name": "測試0312",
                "record": "http://sobot-test.oss-cn-beijing.aliyuncs.com/call/ai/TTS/1031cfafda3f770ac4a7b51e5f164981.mp3",
                "templateid": "1bf61b127bbd4921b482eb35fde5d215",
                "content": "你好"
            },
            {
                "template_name": "接口調用",
                "record": "",
                "templateid": "6a6d592bf37e4898bcfafd1cb4384f29",
                "content": ""
            },
            {
                "template_name": "測試11",
                "record": "http://sobot.oss-cn-beijing.aliyuncs.com/icall/voice/7201f49f125d47e79d5bdd1421b14c25/f1bafa17e5e1492ba1de859a8abba66e.wav,http://sobot.oss-cn-beijing.aliyuncs.com/icall/voice/7201f49f125d47e79d5bdd1421b14c25/0d6e655090ad4f8993eebb6b1ab79dd5.wav",
                "templateid": "43016bcbf54740b78672788ba2aab59a",
                "content": "開場白"
            }
        ],
        "ret_msg": "查詢成功",
        "ret_code": "000000"
    }
    

    # 2.3、查詢可用機器人數

    接口說明:

    接口類型:主動調用接口

    接口作用:查詢智能外呼系統中可用機器人數,用于接口創建任務。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_robot_num

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    robot_num 整形 返回結果 可用機器人數量

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_robot_num?appid=XXXXXX&signature=XXXXXX

    返回示例:

    {
        "robot_num": 4,
        "ret_msg": "查詢成功",
        "ret_code": "000000"
    }
    

    # 2.4、查詢外顯號碼信息

    接口說明:

    接口類型:主動調用接口

    接口作用:查詢智能外呼系統中的外顯號碼信息,用于接口創建任務。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_number

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    total_count 整形 總并發
    data 對象 線路信息 詳見下文

    返回data:

    參數 類型 必填 名稱 備注
    telephone 字符串 外顯號碼
    count 字符串 并發

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_number?appid=XXXXXX&signature=XXXXXX

    返回示例:

    {
        "data": [
            {
                "count": 2,
                "telephone": "02180344315"
            }
        ],
        "total_count": 2,
        "ret_msg": "查詢成功",
        "ret_code": "000000"
    }
    

    # 2.5、創建任務

    接口說明:

    接口類型:主動調用接口

    接口作用:在智能外呼系統中創建一個機器人外呼任務。

    請求方式:

    POST

    請求地址:

    https://icall.sobot.com/api/icall/5/task/add_task

    請求參數:

    參數 類型 必填 名稱
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    templateid 字符串 模板id
    task_name 字符串 任務名稱
    line_type 整型 線路類型,1:固話
    telephone 字符串 外顯號碼,多個用","分隔
    start_time 時間戳 自定義有效期開始時間,13位
    end_time 時間戳 自定義有效期結束時間,13位
    robot_num 整型 機器人數
    time_type 整型 有效期 1:自定義 ;2:永久
    call_time_slot 字符串 撥打時間段,示例:10:00-19:00,多個時間段以英文逗號隔開例如:09:00-20:00,21:00-22:00
    task_status 整型 任務狀態傳0即可
    push_url 字符串 結果推送地址
    push_type 整型 結果推送方式,1:轉人工后推送 2:通話結束后推送
    number_hide 整型 號碼隱藏,默認不開啟。0:不開啟,1:隱藏后四位,2:隱藏中間四位。
    export_status 整型 允許結果導出,默認允許。0:允許,1:不允許。

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    data 對象 返回結果 詳見下文

    返回data:

    參數 類型 必填 名稱
    taskid 字符串 任務id

    請求示例:

    {
        "appid":"xxxxxxxxxx",             //智齒提供的appid
        "signature": "xxxxxxxxxxxxx",   //智齒提供的signature
        "templateid":"模板id",         //撥打電話時使用的模板,需在系統中提前設置模板
        "task_name": "任務名稱",           //本次任務的名稱
        "line_type":"線路類型",             //本次任務撥打時用的線路類型1:固話
        "telephone":"telephone",         //本次任務撥打時需要顯示的外顯號碼(需提前配置外顯號)
        "robot_num": "機器人數目",         //本次任務撥打時機器人的數目(需提前配置)
        "time_type":"有效期",                 //本次任務的有效期1:自定義  ;2:永久
        "start_time": "13位時間戳",          //本次任務有效期為自定義時的開始時間
        "end_time":"13位時間戳",       // 本次任務有效期為自定義時的結束時間
        "call_time_slot": "撥打時間段",      //本次任務將在此時間段進行撥打
        "task_status":"0",
        "push_url":"結果推送接收地址",  
        "push_type":"結果推送方式"       
    }
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "創建任務成功",
    	"data": {
    		"taskid": "XXXXXX"
    	}
    }
    

    # 2.6、結果推送說明

    接口說明:

    接口類型:被動推送接口

    接口作用:智能外呼系統會將呼叫結果根據創建任務時設置的推送方式和推送地址推送進行推送。

    推送方式:

    POST

    推送地址:

    創建任務時push_type設置的地址。

    推送參數:

    智能外呼系統將撥打結果以JSON的形式推送,字段含義見2.8、查看數據詳情示-返回參數 ,例如下:

    {
        "result":{
        "data":{
            "msg":[{
                    "callid":"soboticallbcf37279feb441ee99f33a9814d26b00",
                    "msg":"您好,我是XXXX的體驗專員,今天給您來電是想了解一下,您第一次在我們平臺下單的體驗怎么樣?",
                    "date_time":1576551750959,
                    "sender_type":1,
                    "remark":null
                },
                {
                    "callid":"soboticallbcf37279feb441ee99f33a9814d26b00",
                    "msg":"挺好的",
                    "date_time":1576551784241,
                    "sender_type":0,
                    "remark":"匹配到:【開場白#肯定】"
                },
                {
                    "callid":"soboticallbcf37279feb441ee99f33a9814d26b00",
                    "msg":"了解了,我們會繼續努力給您提供更好的服務,我們給您準備了一張10元無門檻的紅包,希望您還可以繼續支持我們。",
                    "date_time":1576551784243,
                    "sender_type":1,
                    "remark":null
                }
            ],
            "detail":{
                "callid":"soboticallbcf37279feb441ee99f33a9814d26b00",
                "answer_time":1576551759848,
                "voice_url":"http: \/\/sobot-test.oss-cn-beijing.com\/call\/ai\/123456\/20191217\/20191217110230_soboticallbcf37279feb441ee99f33a9814d26b00.wav",
                "end_time":1576551789308,
                "fee_duration":29460,
                "user_msg_count":1,
                "call_duration":39440,
                "start_time":1576551749868,
                "caller":02180344315,
                "outid":1234554321123666,
                "tel":18207736077,
                "intention_name":"有意向購買\u0001滿意",
                "status":2
            }
        },
        "ret_code":000000
        }
    }
    

    # 2.7、提交數據

    接口說明:

    接口類型:主動調用接口

    接口作用:在智能外呼系統中的某一個任務下上傳外呼的數據。

    請求方式:

    POST

    請求地址:

    https://icall.sobot.com/api/icall/5/task/add_task_data

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id,創建任務接口返回的任務id
    data 字符串對象數組 任務數據 見下文

    data說明:

    json數組,數據格式如下,示例: [{"telephone":"xxx","outi d":"xxx","variable":"會議地點^銀海大廈|參會人性別^先生"}]

    傳入參數data格式:

    參數 類型 必填 名稱
    telephone 字符串 用戶電話,不符合電話格式的數據將會被過濾掉。
    outid 字符串 數據id,需要保證唯一,請自行傳值,查看數據詳情也用到該id
    variable 字符串 見下文

    variable參數說明:

    模板變量,變量名與變量值用^分隔,多個變量用|分隔,示例"變量名1^變量值1|變量名2^變量值2"

    返回參數:

    參數 類型 必填 名稱
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息

    請求示例:

    {
        "appid":"xxxxxxxxxx",             //智齒提供的appid
        "signature": "xxxxxxxxxxxxx",             //智齒提供的signature
        "taskid":"xxxx",             //提交的任務id,在創建任務接口返回
        "data": [{
            "telephone":"15988888888",             //撥打的電話號碼
            "outid":"xxxxxxxx",             //任務數據的id,需唯一,根據此字段查看數據撥打詳情
            "variable":"會議地點^銀海大廈|參會人性別^先生"             //變量,需在配置模板時有相應的變量字段
        }]
    }
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "提交數據成功"
    }
    

    # 2.8、文件提交數據

    接口說明:

    接口類型:主動調用接口

    接口作用:在智能外呼系統中的某一個任務下excel文件上傳外呼的數據。

    請求方式:

    POST

    請求地址:

    /api/icall/5/task/add_task_file_data

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id,創建任務接口返回的任務id
    data_file Excel文件 任務數據文件 接口對接通過MultipartFile方式發送發送請求,文件大小限制不大于5MB,數據條數限制不超過10萬條。

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    counts 整型 上傳總條數
    defeat_counts 整型 失敗條數
    repeat_counts 整型 重復條數
    success_counts 整型 成功條數
    filter_count 整型 過濾條數
    error_data 集合 錯誤數據行號

    返回示例:

    {
        "counts": 2,
        "defeat_counts": 1,
        "repeat_counts": 0,
        "success_counts": 1,
        "ret_msg": "本次導入數據2條,成功1條,過濾免打擾客戶數據0條,失敗1條",
        "filter_count": 0,
        "ret_code": "000000",
        "error_data": [
            3
        ]
    }
    

    # 2.9、查看數據詳情

    接口說明:

    接口類型:主動調用接口

    接口作用:在智能外呼系統中查看某個任務的數據詳情。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_task_data

    請求參數:

    參數 類型 必填 名稱
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    outid 字符串 數據id
    taskid 字符串 數據所在任務id

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    data 對象 返回結果信息 詳見下文

    data對象:

    參數 類型 必填 名稱 備注
    detail 對象 基本通話信息 詳見下文
    msg 對象數組 通話詳情 詳見下文

    detail對象:

    參數 類型 必填 名稱 備注
    callid 字符串 通話id
    start_time 時間戳 呼叫開始時間,毫秒級時間戳
    answer_time 時間戳 接通時間,毫秒級時間戳
    end_time 時間戳 結束時間,毫秒級時間戳
    call_duration 整型 呼叫時長,外呼時:從撥號開始計時,單位:毫秒
    fee_duration 整型 通話時長,從用戶/機器人摘機開始計時,單位:毫秒
    intention_name 字符串 客戶意向
    status 整型 撥打狀態 0:未撥打 1:撥打中 2:已接通 3:無人接聽 4:關機 5:停號 6:空號 7:拒接 9:用戶正忙
    tel 字符串 用戶號碼
    caller 字符串 外顯號碼
    user_msg_count 整型 用戶消息數
    voice_url 字符串 錄音地址

    msg對象:

    參數 類型 必填 名稱 備注
    callid 字符串 通話Id
    date_time 字符串 時間戳,13位
    msg 字符串 通話內容
    sender_type 字符串 發送者類型,0用戶,1機器人

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_task_data?appid=XXXXXX&signature=XXXXXX&outid=XXXXXX& taskid=XXXXXX

    返回示例:

    {
    "ret_code": "000000", 
        "data": {
            "msg": [
                {
                    "callid": "soboticallebb1c75dc9794510aa0c1ed76fb0c576",
                    "msg": "您好,我是XXX的體驗專員,今天給您來電是想了解一下,您第一次在我們平臺下單的體驗怎么樣?",
                    "date_time": "1570607971174",
                    "sender_type": "1"
                },
                {
                    "callid": "soboticallebb1c75dc9794510aa0c5ed76fb0c576",
                    "msg": "挺好的",
                    "date_time": "1570608002233",
                    "sender_type": "0"
                }
            ],
            "detail": {
                "callid": "soboticallebb1c75dc9794510aa0c1ed76fb0c576",
                "answer_time": 1570607985848,
                "start_time": 1570607970268,
                "caller": "02180344315",
                "voice_url": "http://sobot-test.oss-cn-beijing.com/call/ai/d8c3a878727c4beda55bae9ec183297f/20191009/20191009155930_soboticallebb1c75dc9794510aa0c5ed76fb0c576.wav",
                "end_time": 1570608025308,
                "fee_duration": 39460,
                "tel": "182****6077",
                "user_msg_count": 1,
                "call_duration": 55040,
                "intention_name": "",
                "status": 2
            }
        }
    }
    

    # 2.10、查詢任務

    接口說明:

    接口類型:主動調用接口

    接口作用:查詢該公司下所有非完結任務

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_task

    請求參數:

    參數 類型 必填 名稱
    appid 字符串 智齒分配
    signature 字符串 智齒分配

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    data 對象 返回結果信息 詳見下文

    返回data:

    參數 類型 必填 名稱 備注
    taskid 字符串 任務id
    task_name 字符串 任務名稱
    task_status 整型 任務狀態 0未開始,1進行中,2已完結,3撥打時間段外,4排隊中,5暫停中

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_task?appid=XXXXXX&signature=XXXXXX
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "繼續任務成功",
        "data": [
                {
                    "task_name": "任務1",
                    "task_status": 0,
                    "taskid": "100018163bcf0dc314eadaf7e13280548658c"
                },
                {
                    "task_name": "任務2",
                    "task_status": 1,
                    "taskid": "10001de2077f6e3724924a978afdf86070ad6"
                },
                {
                    "task_name": "任務2",
                    "task_status": 5,
                    "taskid": "1000182e3744c81954b6d9306cb0343527aab"
                }
            ]
    }
    

    # 2.11、編輯任務

    接口說明:

    接口類型:主動調用接口

    接口作用:編輯修改任務屬性

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/editor_task

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id
    task_name 字符串 任務名稱
    telephone 字符串 外顯號碼,多個用","分隔
    start_time 時間戳 自定義有效期開始時間,13位
    end_time 時間戳 自定義有效期結束時間,13位
    robot_num 整型 機器人數
    time_type 整型 有效期 1:自定義 ;2:永久
    call_time_slot 字符串 撥打時間段,示例:10:00-19:00,多個時間段以英文逗號隔開例如:09:00-20:00,21:00-22:00

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息

    請求示例:

    {
        "appid":"xxxxxxxxxx",             //智齒提供的appid
        "signature": "xxxxxxxxxxxxx",   //智齒提供的signature
        "taskid":"任務id",			//本次任務得id
        "task_name": "任務名稱",           //本次任務的名稱
        "telephone":"telephone"          //本次任務撥打時需要顯示的外顯號碼(需提前配置外顯號)
        "robot_num": "機器人數目",         //本次任務撥打時機器人的數目(需提前配置)
        "time_type":"有效期"                  //本次任務的有效期1:自定義  ;2:永久
        "start_time": "13位時間戳",          //本次任務有效期為自定義時的開始時間
        "end_time":"13位時間戳",       // 本次任務有效期為自定義時的結束時間
        "call_time_slot": "撥打時間段",      //本次任務將在此時間段進行撥打
        "
    }
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "編輯任務成功"
    }
    

    # 2.12、暫停任務

    接口說明:

    接口類型:主動調用接口

    接口作用:對進行中、撥打時間段外、排隊中的任務進行暫停。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/pause_task

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息

    請求示例:

    https://icall.sobot.com/api/icall/5/task/pause_task?appid=XXXXXX&signature=XXXXXX&taskid=XXXXXX
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "暫停成功"
    }
    

    # 2.13、繼續任務

    接口說明:

    接口類型:主動調用接口

    接口作用:對暫停中的任務繼續執行

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/resume_task

    請求參數:

    參數 類型 必填 名稱
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id

    返回參數:

    參數 類型 必填 名稱
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息

    請求示例:

    https://icall.sobot.com/api/icall/5/task/resume_task?appid=XXXXXX&signature=XXXXXX&taskid=XXXXXX
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "繼續任務成功"
    }
    

    # 2.14、完結任務

    接口說明:

    接口類型:主動調用接口

    接口作用:完結終止任務

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/end_task

    請求參數:

    參數 類型 必填 名稱
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id

    返回參數:

    參數 類型 必填 名稱
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息

    請求示例:

    /api/icall/5/task/end_task?appid=XXXXXX&signature=XXXXXX& taskid =XXXXXX
    

    返回示例:

    {
    	"ret_code": "000000",
    	"ret_msg": "完結成功"
    }
    

    # 2.15、查看任務詳情

    接口說明:

    接口類型:主動調用接口

    接口作用:查詢智能外呼系統中某個任務詳情,支持多個任務查詢。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_task_info

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id,多個用","分隔,最多不超過15個。

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    data 對象 返回結果列表 詳見下文

    返回data:

    參數 類型 必填 名稱 備注
    taskid 字符串 任務id
    task_name 字符串 任務名稱
    task_status 字符串 任務狀態 -1 已刪除,0未開始,1進行中,2 已完結, 3撥打時間段外,4排隊中,5暫停中
    telephone 字符串 外顯號碼,多個用","分隔
    robot_num 整型 機器人數
    call_time_slot 字符串 撥打時間段,示例:10:00-19:00
    time_type 整型 有效期 1:自定義 ;2:永久
    start_time 時間戳 自定義有效期開始時間,13位
    end_time 時間戳 自定義有效期結束時間,13位
    call_total_data 整型 任務數據總量
    call_times 整型 已撥打數據量
    call_connected_times 整型 已接通數據量
    call_intent_times 整型 有意向的數據量

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_task_info?appid=XXXXXX&signature=XXXXXX

    返回示例:

    {
        "data": [
            {
                "call_times": 115,
                "call_intent_times": 1,
                "task_name": "1212-01",
                "call_total_data": 508,
                "task_status": 5,
                "time_type": 2,
                "call_time_slot": "09:00-20:00",
                "end_time": null,
                "robot_num": 4,
                "telephone": "02180344315",
                "start_time": null,
                "call_connected_times": 5,
                "taskid": "1000110d35472707c4067808f68271e07e787"
            },
            {
                "call_times": 6,
                "call_intent_times": 0,
                "task_name": "1227",
                "call_total_data": 6,
                "task_status": 2,
                "time_type": 2,
                "call_time_slot": "09:00-20:00",
                "end_time": null,
                "robot_num": 1,
                "telephone": "02180344315",
                "start_time": null,
                "call_connected_times": 6,
                "taskid": "10001ec873e088ee0419293886b75ed9db814"
            }
        ],
        "ret_msg": "查詢成功",
        "ret_code": "000000"
    }
    
    

    # 2.16、刪除任務

    接口說明:

    接口類型:主動調用接口

    接口作用:刪除智能外呼系統中某個任務。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/delete_task

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息

    請求示例:

    https://icall.sobot.com/api/icall/5/task/delete_task?appid=XXXXXX&signature=XXXXXX&taskid=XXXXXX
    

    返回示例:

    {
        "ret_msg": "刪除成功",
        "ret_code": "000000"
    }
    

    # 2.17、刪除撥打數據

    接口說明:

    接口類型:主動調用接口

    接口作用:刪除智能外呼系統中某個任務中的撥打數據。

    請求方式:

    POST

    請求地址:

    /api/icall/5/task/delete_task_data

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id
    outid 字符串 數據id,多個用英文逗號隔開,單次最多100條,如有重復一并刪除

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    del_counts 整型 刪除條數

    請求示例:

    {
        "appid": "xxxxxxxxxx", //智齒提供的appid
        "signature": "xxxxxxxxxxxxx", //智齒提供的signature
        "taskid": "xxxxxxxxxxxxx", //任務id
        "outid": "xxxxxxxx,xxxxxxxx" //任務id
    }
    

    返回示例:

    {
        "ret_msg": "刪除成功",
        "ret_code": "000000",
        "del_counts": 2
    }
    

    # 2.18、查詢時間段內撥打量

    接口說明:

    接口類型:主動調用接口

    接口作用:獲取指定時間段內指定任務的外呼已完成數據總數。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/calls_count

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 任務id,多個用","分隔,最多不超過15個。
    begin_time 時間戳 13位毫秒時間戳
    end_time 時間戳 13位毫秒時間戳

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    data 對象 返回結果列表 詳見下文

    返回data:

    參數 類型 必填 名稱 備注
    taskid 字符串 任務id
    task_name 字符串 任務名稱
    count 整型 該時段內指定任務下已完成外呼數據的總數

    請求示例:

    https://icall.sobot.com/api/icall/5/task/calls_count?appid=XXXX&signature=XXXX&taskid=100017add6b22e5884678a6c1c861f73beae8,100010484d4fb8d734888b0ec89f0978d5e20&begin_time=1577436030000&end_time=1579086041000
    

    返回示例:

    {
        "data": [
            {
                "task_name": "20.01.15測試",
                "count": 25,
                "taskid": "100017add6b22e5884678a6c1c861f73beae8"
            },
            {
                "task_name": "測試任務",
                "count": 1,
                "taskid": "100010484d4fb8d734888b0ec89f0978d5e20"
            }
        ],
        "ret_msg": "查詢成功",
        "ret_code": "000000"
    }
    

    # 2.19、獲取指定時間段內外呼數據詳情

    接口說明:

    接口類型:主動調用接口

    接口作用:獲取指定時間段內外呼數據詳情。

    請求方式:

    GET

    請求地址:

    https://icall.sobot.com/api/icall/5/task/query_time_task_data

    請求參數:

    參數 類型 必填 名稱 備注
    appid 字符串 智齒分配
    signature 字符串 智齒分配
    taskid 字符串 數據所在任務id
    begin_time 時間戳 13位毫秒時間戳
    end_time 時間戳 13位毫秒時間戳
    page_size 整型 每頁大小,最大不超過15
    page_num 整型 頁碼

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code 字符串 執行結果碼
    ret_msg 字符串 返回信息
    page_count 整型 總頁數
    total_count 整型 總數據量
    data 對象集合 返回結果集合 詳見下文

    data對象:

    參數 類型 必填 名稱 備注
    detail 對象 基本通話信息 詳見下文
    msg 對象數組 通話詳情 詳見下文

    detail對象:

    參數 類型 必填 名稱 備注
    callid 字符串 通話id
    start_time 時間戳 呼叫開始時間,毫秒級時間戳
    answer_time 時間戳 接通時間,毫秒級時間戳
    end_time 時間戳 結束時間,毫秒級時間戳
    call_duration 整型 呼叫時長,外呼時:從撥號開始計時,單位:毫秒
    fee_duration 整型 通話時長,從用戶/機器人摘機開始計時,單位:毫秒
    intention_name 字符串 客戶意向
    status 整型 撥打狀態 0:未撥打 1:撥打中 2:已接通 3:無人接聽 4:關機 5:停號 6:空號 7:拒接 9:用戶正忙
    tel 字符串 用戶號碼
    caller 字符串 外顯號碼
    user_msg_count 整型 用戶消息數
    voice_url 字符串 錄音地址
    del_flag 整型 刪除標志 1:正常,-1:刪除

    msg對象:

    參數 類型 必填 名稱 備注
    callid 字符串 通話Id
    date_time 字符串 時間戳,13位
    msg 字符串 通話內容
    sender_type 字符串 發送者類型,0用戶,1機器人

    請求示例:

    https://icall.sobot.com/api/icall/5/task/query_time_task_data?appid=XXXX&signature=XXXXXX&taskid=100017add6b22e5884678a6c1c861f73beae8&begin_time=1575189630001&end_time=1579086041000&page_size=2&page_num=1
    

    返回示例:

    {
        "data": [
            {
                "msg": [
                    {
                        "callid": "soboticall7b2e7dbb3006439195d03daed5088ff5",
                        "msg": "您好,我是XXXX的體驗專員,今天給您來電是想了解一下,您第一次在我們平臺下單的體驗怎么樣?",
                        "date_time": "1579084972898",
                        "sender_type": "1"
                    }
                ],
                "detail": {
                    "callid": "soboticall7b2e7dbb3006439195d03daed5088ff5",
                    "answer_time": "0",
                    "del_flag": "-1",
                    "voice_url": "http://sobot-test.oss-cn-beijing.aliyuncs.com/call/ai/123456/20200115/20200115184252_soboticall7b2e7dbb3006439195d03daed5088ff5.wav",
                    "end_time": "1579084974374",
                    "fee_duration": "0",
                    "user_msg_count": "0",
                    "call_duration": "1930",
                    "start_time": "1579084972444",
                    "caller": "02180344315",
                    "tel": "18201666077",
                    "intention_name": "",
                    "status": "3"
                }
            },
            {
                "msg": [
                    {
                        "callid": "soboticall51d0048b18394c4d9bcaa5981bcb08f3",
                        "msg": "您好,我是XXXX的體驗專員,今天給您來電是想了解一下,您第一次在我們平臺下單的體驗怎么樣?",
                        "date_time": "1579084972897",
                        "sender_type": "1"
                    },
                    {
                        "callid": " soboticall51d0048b18394c4d9bcaa5981bcb08f3",
                        "msg": "挺好的",
                        "date_time": "1579084975134",
                        "sender_type": "0"
                    }
                ],
                "detail": {
                    "callid": "soboticall51d0048b18394c4d9bcaa5981bcb08f3",
                    "answer_time": "0",
                    "del_flag": "1",
                    "voice_url": "http://sobot-test.oss-cn-beijing.aliyuncs.com/call/ai/123456/20200115/20200115184252_soboticall51d0048b18394c4d9bcaa5981bcb08f3.wav",
                    "end_time": "1579084974547",
                    "fee_duration": "0",
                    "user_msg_count": "0",
                    "call_duration": "2120",
                    "start_time": "1579084972427",
                    "caller": "02180344315",
                    "tel": "18500974776",
                    "intention_name": "",
                    "status": "3"
                }
            }
        ],
        "total_count": 25,
        "ret_code": "000000",
        "page_count": 13
    }
    

    # 2.20、開放接口demo

    Demo:

    import java.io.BufferedReader;
    import java.io.IOException;
    import java.io.InputStreamReader;
    import java.io.PrintWriter;
    import java.io.UnsupportedEncodingException;
    import java.net.URL;
    import java.net.URLConnection;
    import java.net.URLEncoder;
    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    import java.util.UUID;
    import net.sf.json.JSONArray;
    
    /**
    *智能外呼開放接口請求示例 
    *該示例包括兩個接口:創建任務和提交數據
    */
      public class PlatformDemo {
      private static String BASEURI = " [https://icall.sobot.com/api/icall/5/task/]( https://icall.sobot.com/api/icall/5/task/)";
    
      public static void main(String[] args) {
          System.out.println(addTask()); // 創建任務
          System.out.println(addTaskData()); // 提交數據
      }
      // 創建任務
      public static String addTask() {
          // 鏈接
          String addTaskUri = BASEURI + " add_task ";
          // 參數
          Map<String, Object> parmaMap = new HashMap<String, Object>();
          parmaMap.put("appid", "xxxxxx");
          parmaMap.put("signature", "xxxxxxxxxxxxxxxxxx");
          parmaMap.put("templateid", "xxxxxxxxxxxxxxxxxxxxx");
          parmaMap.put("task_name", "創建任務");
          parmaMap.put("line_type", "1");
          parmaMap.put("telephone", "xxxxxxxx");
          parmaMap.put("robot_num", "1");
          parmaMap.put("time_type", "2");
          parmaMap.put("call_time_slot", "8:00-19:00");
          parmaMap.put("task_status", "0");
          String result = sendPost(addTaskUri, parmaMap);
          return result;
      }
    
      // 添加任務數據
      public static String addTaskData() {
          // 鏈接
          String addTaskUri = BASEURI + " add_task_ata";
          // 參數
          Map<String, Object> parmaMap = new HashMap<String, Object>();
          parmaMap.put("appid", "xxxxxxx");
          parmaMap.put("signature", "xxxxxxxxxxxxxxxxxxxxxxxxxx");
          parmaMap.put("taskid", "xxxxxxxxxxxxxxxxxxxxxxxx");
          // 變量信息
          List<Map<String, String>> dataList = new ArrayList<Map<String, String>>();
          Map<String, String> dataMap = new HashMap<String, String>();
          dataMap.put("telephone", "1591083****");
          dataMap.put("outid", String.valueOf(UUID.randomUUID()));
          dataMap.put("variable", "公司^公司名");
          dataList.add(dataMap);
          JSONArray dataJson = JSONArray.fromObject(dataMap);
          parmaMap.put("data", dataJson);
          String result = sendPost(addTaskUri, parmaMap);
          return result;
      }
    
      public static String sendPost(String url, Map<String, Object> param) {
          StringBuffer buffer = new StringBuffer();
          if (param != null && !param.isEmpty()) {
              for (Map.Entry<String, Object> entry : param.entrySet()) {
                  try {
                      if (entry.getValue() != null) {
                          buffer.append(entry.getKey()).append("=")
                                  .append(URLEncoder.encode(entry.getValue().toString(), "utf-8")).append("&");
                      }
                  } catch (UnsupportedEncodingException e) {
                      e.printStackTrace();
                  }
              }
              buffer.deleteCharAt(buffer.length() - 1);
          }
          PrintWriter out = null;
          BufferedReader in = null;
          String result = "";
          try {
              URL realUrl = new URL(url);
              // 打開和URL之間的連接
              URLConnection conn = realUrl.openConnection();
              // 設置通用的請求屬性
              conn.setRequestProperty("accept", "*/*");
              conn.setRequestProperty("connection", "Keep-Alive");
              conn.setRequestProperty("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");
              conn.setConnectTimeout(30000);
              conn.setReadTimeout(30000);
              // 發送POST請求必須設置如下兩行
              conn.setDoOutput(true);
              conn.setDoInput(true);
              // 獲取URLConnection對象對應的輸出流
              out = new PrintWriter(conn.getOutputStream());
              // 發送請求參數
              out.print(buffer);
              // flush輸出流的緩沖
              out.flush();
              // 定義BufferedReader輸入流來讀取URL的響應
              in = new BufferedReader(new InputStreamReader(conn.getInputStream(), "UTF-8"));
              String line;
              while ((line = in.readLine()) != null) {
                  result += line;
              }
          } catch (Exception e) {
              e.printStackTrace();
          }
          // 使用finally塊來關閉輸出流、輸入流
          finally {
              try {
                  if (out != null) {
                      out.close();
                  }
                  if (in != null) {
                      in.close();
                  }
              } catch (IOException ex) {
                  ex.printStackTrace();
              }
          }
          return result;
      }
      }
    

    # 3、狀態編碼

    # 3.1、操作成功

    業務操作成功。

    狀態編碼 狀態說明
    000000 操作成功(除此編碼以外的編碼為錯誤編碼)

    # 3.2、系統異常

    系統服務異常。

    錯誤編碼 錯誤說明
    320001 appid或者signature有誤
    329999 系統未知異常

    # 3.3、業務異常

    業務異常。

    錯誤編碼 錯誤說明
    320011 模板id為空
    320012 任務名稱為空
    320013 機器人數量有誤
    320014 外顯號碼為空
    320015 有效期類型為空
    320016 自定義有效期開始或結束時間為空
    320017 撥打時間段為空
    320018 data格式錯誤
    320019 任務或者模板有誤
    320020 任務已經被刪除
    320021 任務id為空
    320022 任務id有誤
    320023 任務未開始或已完結
    320024 只有暫停中的任務可以繼續操作
    320025 驗證郵箱為空
    320026 開始時間為空
    320027 結束時間為空
    320028 文件格式不正確
    320029 大于最大上傳條數
    320030 上傳的數據有誤
    320031 上傳文件不存在
    320032 outid為空
    320033 outid數量超出限制
    大星彩票 <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <文本链> <文本链> <文本链> <文本链> <文本链> <文本链>