You need to enable JavaScript to run this app.
导航
智能外呼
  • 文档首页
    • /
  • 智能外呼

智能外呼接入文档

最近更新时间：2023.08.18 14:48:28

首次发布时间：2022.06.08 15:34:11

我的收藏
Part-1 任务管理

一、创建任务

1、接口入参

名称类型是否必选示例值描述
NameString是task1任务名称
PhoneListList< PhoneParamDTO >是[{"Phone":"15233345567"}]号码列表，PhoneParam结构参照上方数据结构中的描述，单次最多1w条
ScriptString是smb_commentsailab话术
NumberPoolNoString是NP160084061100694433号码池编号
NumberListList是["13344445555","13255556666"]选出用于拨打的号码
StartTimeString是2021-05-18 20:11:42到了该时间任务开始执行
EndTimeString是2021-05-18 20:11:42到了该时间任务停止执行
RingAgainTimesInteger否1重呼次数，默认0
RingAgainIntervalInteger否5重呼间隔，最小5分钟，默认5
UniqueBoolean否false是否开启号码去重，默认false不去重
ForbidTimeListList否[{"Times":["10:00-11:00"],"Weekdays":[3]}]禁呼时间列表，ForbidTimeItem结构参照上方数据结构中的描述
ConcurrencyNumber是12并发量

PhoneParamDTO

名称类型是否必传示例值描述
PhoneString是123手机号码
VariableParamsMap否["Index":0,"Phone":"15233334444"]变量

ForbidTimeItem

名称类型是否必传示例值描述
WeekdaysArrays否[1,2,3]星期几，1表示周日，2表示周一
TimesArrays否"[\"09:00-10:00\",\"15:00-16:00\"]"["Index":0,"":"15233334444"]时间段

2、接口出参

名称类型示例值描述
TaskIdString123创建的任务Id
FailPhoneListList["Index":0,"Phone":"15233334444"]添加失败的号码

3、请求示例

curl --location --request POST  '{baseUrl}?Action=CreateTask&Version=2021-01-01'  \
--header  'ServiceName: volc_voice_robot'  \
--header  'Region: cn-north-1'  \
--header  'Content-Type: application/json'  \
--data-raw  '{
        "Name":"task1",
        "Resource":"e1412fe09be840e4a35c0633331a475d",
        "NumberList":[
                "057156199918"
        ],
        "Concurrency":1,
        "ForbidTimeList":[
                {
                        "Weekdays":[
                                1
                        ],
                        "Times":[
                                "10:00-11:00"
                        ]
                }
        ],
        "RingAgainTimes":1,
        "RingAgainInterval":5,
        "EndTime":"2021-05-21 17:35:44",
        "StartTime":"2021-05-20 17:35:43",
        "PhoneList":[
                {
                        "Phone":"17052992739"
                }
        ],
        "Unique":true,
        "NumberPoolNo":"NP161268484610905956"
}'

4、返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"CreateTask",
        "Version":"2021-01-01",
        "Service":"volc_voice_robot",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskId":77,
        "FailPhoneList":[

        ]
    }
}

二、暂停任务

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotPauseTask2021-01-01Get

2、接口入参

名称类型是否必选示例值描述
TaskIdString是123任务Id

3、接口出参

名称类型示例值描述
TaskIdString123创建的任务Id

4、请求示例

curl --location --request POST  '{baseUrl}?Action=PauseTask&Version=2021-01-01'  \
--header  'ServiceName: volc_voice_robot'  \
--header  'Region: cn-north-1'  \
--header  'Content-Type: form/data'  \
--form  'TaskId="1"'

5、返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"PauseTask",
        "Version":"2021-01-01",
        "Service":"volc_voice_robot",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskId":"1"
    }
}

三、恢复任务

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotResumeTask2021-01-01Get

2、接口入参

名称类型是否必选示例值描述
TaskIdString是123任务Id

3、接口出参

名称类型示例值描述
TaskIdString123创建的任务Id

4、请求示例

curl --location --request POST  '{baseUrl}?Action=ResumeTask&Version=2021-01-01'  \
--header  'ServiceName: volc_voice_robot'  \
--header  'Region: cn-north-1'  \
--header  'Content-Type: form/data'  \
--form  'TaskId="1"'

5、返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"ResumeTask",
        "Version":"2021-01-01",
        "Service":"volc_voice_robot",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskId":"1"
    }
}

四、终止任务

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotStopTask2021-01-01Get

2、接口入参

名称类型是否必选示例值描述
TaskIdString是123任务Id

3、接口出参

名称类型示例值描述
TaskIdString123创建的任务Id

4、请求示例

curl --location --request POST  '{baseUrl}?Action=StopTask&Version=2021-01-01'  \
--header  'ServiceName: volc_voice_robot'  \
--header  'Region: cn-north-1'  \
--header  'Content-Type: form/data'  \
--form  'TaskId="1"'

5、返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"StopTask",
        "Version":"2021-01-01",
        "Service":"volc_voice_robot",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskId":"1"
    }
}

五、更新任务

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotUpdateTask2021-01-01Post

2、接口入参

名称类型是否必选示例值描述
TaskIdString是123任务Id
StartTimeString是2021-05-18 20:11:42到了该时间任务开始执行
EndTimeString是2021-05-18 20:11:42到了该时间任务停止执行
RingAgainTimesInteger否1重呼次数，默认0
RingAgainIntervalInteger否5重呼间隔，最小5分钟，默认5
ForbidTimeListList否[{"Times":["10:00-11:00"],"Weekdays":[3]}]禁呼时间列表，ForbidTimeItem结构参照上方数据结构中的描述
ConcurrencyNumber是12并发量

3、接口出参

名称类型示例值描述
TaskIdString123创建的任务Id

4、请求示例

curl --location --request POST  '{baseUrl}?Action=UpdateTask&Version=2021-01-01'  \
--header  'ServiceName: volc_voice_robot'  \
--header  'Region: cn-north-1'  \
--header  'Content-Type: application/json'  \
--data-raw  '{
        "TaskId":123,
        "Concurrency":1,
        "ForbidTimeList":[
                {
                        "Weekdays":[
                                1
                        ],
                        "Times":[
                                "10:00-11:00"
                        ]
                }
        ],
        "RingAgainTimes":1,
        "RingAgainInterval":5,
        "EndTime":"2021-05-21 17:35:44",
        "StartTime":"2021-05-20 17:35:43"
}'

5、返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"UpdateTask",
        "Version":"2021-01-01",
        "Service":"volc_voice_robot",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskId":77
    }
}

六、添加号码

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotBatchAppend2021-01-01Post

2、接口入参

名称类型是否必选示例值描述
TaskIdInteger是123任务Id
PhoneListList是[{"Phone":"15233345567"}]号码列表，PhoneParam结构参照上方数据结构中的描述，单次最多1w条

3、接口出参

名称类型示例值描述
TaskIdString123创建的任务Id
FailPhoneListList["Index":0,"Phone":"15233334444"]添加失败的号码

4、请求示例

curl --location --request POST  '{baseUrl}?Action=BatchAppend&Version=2021-01-01'  \
--header  'ServiceName: volc_voice_robot'  \
--header  'Region: cn-north-1'  \
--header  'Content-Type: application/json'  \
--data-raw  '{
        "TaskId":'123',
        "PhoneList":[
                {
                        "Phone":"17052992739"
                },  
                {
                        "Phone":"17052992733
                }
        ]
}'

5、返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"BatchAppend",
        "Version":"2021-01-01",
        "Service":"volc_voice_robot",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskId":'123',
        "FailList":[

        ]
    }
}

七、任务列表

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotQueryTaskList2021-01-01Post

2、接口入参

名称类型是否必选示例值描述
KeyWordString否task1任务名称或者任务id
TaskStatusArrays否1，2，3任务状态
TaskScriptString否smb_comments任务话术
CalledPhoneString否13370000000呼叫号码
BussinessLineIdArrays否[1111,1112]业务线id
OffestNumber是0分页的偏移量
LimitNumber是20分页的每页数量

3、接口出参

名称类型示例值描述
TaskIdString1111任务id
TaskNameStringtask任务名称
TaskStatusNumber1任务状态
StartTimeDate2021-07-01 00:00:00开始时间
EndTimeDate2021-07-01 00:00:00结束时间
ListSizeNumber12名单数
CalledSizeNumber1呼叫数
ThroughSizeNumber1接通数
ThroughRateNumber100%接通率
FinishRateNumber100%完成率
OffestNumber0偏移量
LimitNumber20每页数量
TotalNumber100数据总量
Part-2 话术部分

一、话术查询

1、接口定义

ServiceActionVersion请求方式
volc_voice_robotQueryScript2021-01-01GET

2、接口入参

名称类型是否必选示例值描述

3、接口出参

名称类型示例值描述
Resultlist话术list
ScriptOpenInfo.ScriptStringtest话术
ScriptOpenInfo.NameString话术名称话术名称
ScriptOpenInfo.ConcurrencyInteger10话术并发度
ScriptOpenInfo.DsParamSetlist话术变量
ScriptParamInfo.KeyStringtopic变量名
ScriptParamInfo.ValueString讲座主题变量值
Part-3 外呼数据

一、数据查询

1. 接口定义

ServiceActionVersion请求方式
GET

3. 接口入参

名称类型是否必选示例值描述
schemaquery(string)是qa_test话术名称
start_indexquery(int)是1查询起始页
limitquery(int)是20查询每一页的大小
date_startquery是2022-05-17 15:00:00起点时间
date_endquery(string)是2022-05-17 16:00:00结束时间
account_idquery(string)是2100051477用户id
usernamequery(string)是Zhinengwaihu002用户名

4. 接口出参

名称类型示例值描述
create_dateDate2021-12-29 13:57:12记录创建时间
session_idString0f289a8e-686c-11ec-ab84-0cc47acf79d0bytebot通话id
durationint46483对话时长ms
parent_idstring002CUG3PECFKD5V52J11C2LAES2C20PHocic 通话id
robot_gradingstringA定级信息
labeled_gradingstringA人工定级信息
roundsint4.5通话轮次
dialog_rich_tagsstring[{\"key\":\"car_type_series@brand-model\",\"value\":\"比亚迪\",\"confident\":1,\"value_type\":\"string\",\"detail\":\"{\\\"slots\\\":[{\\\"key\\\":\\\"brand\\\",\\\"value\\\":\\\"比亚迪\\\"}]}\",\"type\":\"slot\"}]槽位抽取信息
dialog_tagsstring[\"{\"interest\":\"汽车\"}\"]标签信息
phone_numberstring18511112324手机号码

5. 请求示例

```apache

url: /console/open/api/v2/bot/scripts/{script_name}/labels
method: GET
参数:
path: script_name
query:
page_index: 1
page_size: 20
date: "2021-12-29 00:00:00" #只会取天

### 6\. 返回示例

```json
{    
    "code":0,    
    "msg":"ok",    
    "data":{        
        "count":12951,        
        "data":[            
            {                
                "create_date":"2021-12-29 13:57:12",                
                "session_id":"0f289a8e-686c-11ec-ab84-0cc47acf79d0", 
                "duration":46483,                
                "parent_id":"002CUG3PECFKD5V52J11C2LAES2C20PH", 
                "robot_grading":"",                
                "labeled_grading":"",                
                "rounds":4.5,                
                "dialog_rich_tags":"[{\"key\":\"car_type_series@brand-model\",\"value\":\"比亚迪\",\"confident\":1,\"value_type\":\"string\",\"detail\":\"{\\\"slots\\\":[{\\\"key\\\":\\\"brand\\\",\\\"value\\\":\\\"比亚迪\\\"}]}\",\"type\":\"slot\"}]",                
                "dialog_tags":"[\"{\"interest\":\"汽车\"}\"]",               
                "phone_number":"xxxxxx"            
            }        
        ]    
    } 
}

Part-1 任务管理

一、创建任务

1、接口入参

2、接口出参

3、请求示例

4、返回示例

二、暂停任务

1、接口定义

2、接口入参

3、接口出参

4、请求示例

5、返回示例

三、恢复任务

1、接口定义

2、接口入参

3、接口出参

4、请求示例

5、返回示例

四、终止任务

1、接口定义

2、接口入参

3、接口出参

4、请求示例

5、返回示例

五、更新任务

1、接口定义

2、接口入参

3、接口出参

4、请求示例

5、返回示例

六、添加号码

1、接口定义

2、接口入参

3、接口出参

4、请求示例

5、返回示例

七、任务列表

1、接口定义

2、接口入参

3、接口出参

Part-2 话术部分

一、话术查询

1、接口定义

2、接口入参

3、接口出参

Part-3 外呼数据

一、数据查询

1. 接口定义

3. 接口入参

4. 接口出参

5. 请求示例