智能外呼接入文档--智能外呼-火山引擎

文档中心

导航

智能外呼接入文档

最近更新时间：2023.08.18 14:48:28首次发布时间：2022.06.08 15:34:11

Part-1 任务管理

一、创建任务

1、接口入参

名称	类型	是否必选	示例值	描述
Name	String	是	task1	任务名称
PhoneList	List< PhoneParamDTO >	是	[{"Phone":"15233345567"}]	号码列表，PhoneParam结构参照上方数据结构中的描述，单次最多1w条
Script	String	是	smb_comments	ailab话术
NumberPoolNo	String	是	NP160084061100694433	号码池编号
NumberList	List	是	["13344445555","13255556666"]	选出用于拨打的号码
StartTime	String	是	2021-05-18 20:11:42	到了该时间任务开始执行
EndTime	String	是	2021-05-18 20:11:42	到了该时间任务停止执行
RingAgainTimes	Integer	否	1	重呼次数，默认0
RingAgainInterval	Integer	否	5	重呼间隔，最小5分钟，默认5
Unique	Boolean	否	false	是否开启号码去重，默认false不去重
ForbidTimeList	List	否	[{"Times":["10:00-11:00"],"Weekdays":[3]}]	禁呼时间列表，ForbidTimeItem结构参照上方数据结构中的描述
Concurrency	Number	是	12	并发量

PhoneParamDTO

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

ForbidTimeItem

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

2、接口出参

名称	类型	示例值	描述
TaskId	String	123	创建的任务Id
FailPhoneList	List	["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、接口定义

Service	Action	Version	请求方式
volc_voice_robot	PauseTask	2021-01-01	Get

2、接口入参

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

3、接口出参

名称	类型	示例值	描述
TaskId	String	123	创建的任务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、接口定义

Service	Action	Version	请求方式
volc_voice_robot	ResumeTask	2021-01-01	Get

2、接口入参

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

3、接口出参

名称	类型	示例值	描述
TaskId	String	123	创建的任务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、接口定义

Service	Action	Version	请求方式
volc_voice_robot	StopTask	2021-01-01	Get

2、接口入参

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

3、接口出参

名称	类型	示例值	描述
TaskId	String	123	创建的任务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、接口定义

Service	Action	Version	请求方式
volc_voice_robot	UpdateTask	2021-01-01	Post

2、接口入参

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

3、接口出参

名称	类型	示例值	描述
TaskId	String	123	创建的任务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、接口定义

Service	Action	Version	请求方式
volc_voice_robot	BatchAppend	2021-01-01	Post

2、接口入参

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

3、接口出参

名称	类型	示例值	描述
TaskId	String	123	创建的任务Id
FailPhoneList	List	["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、接口定义

Service	Action	Version	请求方式
volc_voice_robot	QueryTaskList	2021-01-01	Post

2、接口入参

名称	类型	是否必选	示例值	描述
KeyWord	String	否	task1	任务名称或者任务id
TaskStatus	Arrays	否	1，2，3	任务状态
TaskScript	String	否	smb_comments	任务话术
CalledPhone	String	否	13370000000	呼叫号码
BussinessLineId	Arrays	否	[1111,1112]	业务线id
Offest	Number	是	0	分页的偏移量
Limit	Number	是	20	分页的每页数量

3、接口出参

名称	类型	示例值	描述
TaskId	String	1111	任务id
TaskName	String	task	任务名称
TaskStatus	Number	1	任务状态
StartTime	Date	2021-07-01 00:00:00	开始时间
EndTime	Date	2021-07-01 00:00:00	结束时间
ListSize	Number	12	名单数
CalledSize	Number	1	呼叫数
ThroughSize	Number	1	接通数
ThroughRate	Number	100%	接通率
FinishRate	Number	100%	完成率
Offest	Number	0	偏移量
Limit	Number	20	每页数量
Total	Number	100	数据总量

Part-2 话术部分

一、话术查询

1、接口定义

Service	Action	Version	请求方式
volc_voice_robot	QueryScript	2021-01-01	GET

2、接口入参

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

3、接口出参

名称	类型	示例值	描述
Result	list		话术list
ScriptOpenInfo.Script	String	test	话术
ScriptOpenInfo.Name	String	话术名称	话术名称
ScriptOpenInfo.Concurrency	Integer	10	话术并发度
ScriptOpenInfo.DsParamSet	list		话术变量
ScriptParamInfo.Key	String	topic	变量名
ScriptParamInfo.Value	String	讲座主题	变量值

Part-3 外呼数据

一、数据查询

1. 接口定义

Service	Action	Version	请求方式
			GET

3. 接口入参

名称	类型	是否必选	示例值	描述
schema	query(string)	是	qa_test	话术名称
start_index	query(int)	是	1	查询起始页
limit	query(int)	是	20	查询每一页的大小
date_start	query	是	2022-05-17 15:00:00	起点时间
date_end	query(string)	是	2022-05-17 16:00:00	结束时间
account_id	query(string)	是	2100051477	用户id
username	query(string)	是	Zhinengwaihu002	用户名

4. 接口出参

名称	类型	示例值	描述
create_date	Date	2021-12-29 13:57:12	记录创建时间
session_id	String	0f289a8e-686c-11ec-ab84-0cc47acf79d0	bytebot通话id
duration	int	46483	对话时长ms
parent_id	string	002CUG3PECFKD5V52J11C2LAES2C20PH	ocic 通话id
robot_grading	string	A	定级信息
labeled_grading	string	A	人工定级信息
rounds	int	4.5	通话轮次
dialog_rich_tags	string	[{\"key\":\"car_type_series@brand-model\",\"value\":\"比亚迪\",\"confident\":1,\"value_type\":\"string\",\"detail\":\"{\\\"slots\\\":[{\\\"key\\\":\\\"brand\\\",\\\"value\\\":\\\"比亚迪\\\"}]}\",\"type\":\"slot\"}]	槽位抽取信息
dialog_tags	string	[\"{\"interest\":\"汽车\"}\"]	标签信息
phone_number	string	18511112324	手机号码

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"            
            }        
        ]    
    } 
}