语音机器人开放API

接口鉴权

调用下面开放API接口时，需要在请求的Header中增加鉴权参数。

HeaderKey	值
Authorization	Bearer access_token

Access Token 您需要在美洽公众台【设置 / 开发者 / APIs】中获取，并设置为启用。目前 Token 的有效期是永久，重复获取将导致上次获取的 Token 失效。

curl -s https://api.meiqia.com/ -H Authorization:Bearer access_token

语音机器人-任务列表

基本信息

Path： /unified-api/datagateway/v1/call_robot/tasks/list

Method： GET

接口描述：
语音机器人-任务列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
limit	否
offset	否

返回数据

名称	类型	是否必须	备注	其他信息
data	object []	非必须		item 类型: object
├─ answer_total	integer	必须	应答数	format: int64
├─ call_period	string	必须	呼叫时间段
├─ called_total	integer	必须	呼叫数	format: int64
├─ created_at	string	必须	创建时间	format: date-time
├─ description	string	必须	任务描述
├─ effect_at	string	必须	生效时间	format: date-time
├─ ent_id	integer	必须		format: int64
├─ expire_at	string	必须	过期时间	format: date-time
├─ id	integer	必须		format: int64
├─ name	string	必须	任务名称
├─ out_phones	string	必须	外呼号码
├─ phone_total	integer	必须	号码总数	format: int64
├─ redial	integer	必须	是否重播	format: int32
├─ redial_interval	integer	必须	重播间隔时长	format: int64
├─ redial_times	integer	必须	最大重播次数	format: int32
├─ robot_num	integer	必须	机器人数	format: int32
├─ running_desc	string	必须	运行说明
├─ skill_id	integer	必须	话术模版ID	format: int64
├─ skill_name	object	必须
├─ task_state	string	必须	任务状态:pending:待开始|running:进行中|pausing:暂停中|finished:已完成|closed:已结束|resting:休息中
├─ updated_at	string	必须	更新时间	format: date-time
total	integer	必须		format: int64

语音机器人-外呼任务-添加号码

基本信息

Path： /unified-api/datagateway/v1/call_robot/task/add_phones

Method： POST

接口描述：
语音机器人-外呼任务-添加号码

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
phones	object []	必须	外呼号码数组	item 类型: object
├─ business_id	string	非必须	业务ID(最长64字符)
├─ phone	string	必须	号码
├─ variables	map	非必须	变量	key为变量名称,value为变量具体内容
task_id	integer	必须	外呼任务ID(通过任务列表获得)	format: int64

请求示例

{
    "task_id": 43,
    "phones": [
        {
            "phone": "17100001234",
            "business_id":"12345667890",
            "variables":{
                "姓名":"张三",
                "出生日期":"2023-04-03"
            }
        }
    ]
}

返回数据

名称	类型	是否必须	备注	其他信息
failure_num	integer	必须		format: int64
success_num	integer	必须		format: int64

语音机器人-通话记录列表

基本信息

Path： /unified-api/datagateway/v1/call_robot/records/list

Method： GET

接口描述：
语音机器人-通话记录列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
task_id	否		外呼任务ID
skill_id	否		话术模版ID
start_at	否		开始时间
end_at	否		结束时间
answer_state	否		应答状态
caller	否		主叫号码
callee	否		被叫号码
intent_tag	否		意图标签
offset	否
limit	否

返回数据

名称	类型	是否必须	备注	其他信息
data	object []	必须		item 类型: object
├─ Billsec	integer	必须		format: int64
├─ answer_at	string	非必须	应答时间	format: date-time
├─ answer_state	string	非必须	应答状态:answered:正常接通|not_connected:未接通
├─ billsec	string	非必须	计费时长
├─ business_id	string	非必须	业务ID
├─ call_state	string	必须	呼叫状态:synthesis:待合成|pending:待开始|calling:呼叫中|called:已呼叫|timeout:已超时|replay:待重播|terminated:已终止
├─ callee	string	必须	被叫号码
├─ callee_attribution	string	非必须	被叫号码归属地
├─ caller	string	必须	主叫号码
├─ end_at	string	必须	挂机时间	format: date-time
├─ id	integer	必须		format: int64
├─ intent_tag	integer []	非必须	意图标签ID	item 类型: integer
├─		非必须
├─ record_file	string	非必须	录音文件
├─ redirect	string	非必须
├─ ring_time	string	非必须
├─ skill_name	string	必须	话术模版名称
├─ start_at	string	必须	呼叫开始时间	format: date-time
├─ task_name	string	必须	任务名称
├─ uuid	string	必须
total	integer	必须		format: int64

语音机器人-通话记录详情

基本信息

Path： /unified-api/datagateway/v1/call_robot/records/{uuid}

Method： GET

接口描述：
语音机器人-通话记录详情

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
uuid

返回数据

名称	类型	是否必须	备注	其他信息
Billsec	integer	非必须		format: int64
answer_at	string	非必须	应答时间	format: date-time
answer_state	string	必须	应答状态:answered:正常接通|not_connected:未接通
billsec	string	非必须	计费时长
business_id	string	非必须	业务ID
call_state	string	必须	呼叫状态:synthesis:待合成|pending:待开始|calling:呼叫中|called:已呼叫|timeout:已超时|replay:待重播|terminated:已终止
callee	string	必须	被叫号码
callee_attribution	string	非必须	被叫号码归属地
caller	string	必须	主叫号码
end_at	string	必须	挂机时间	format: date-time
id	integer	非必须		format: int64
intent_tag	integer []	非必须	意图标签ID	item 类型: integer
├─		非必须
record_file	string	非必须	录音文件
redirect	string	非必须
ring_time	string	非必须
skill_name	string	必须	话术模版名称
start_at	string	必须	呼叫开始时间	format: date-time
task_name	string	必须	任务名称
uuid	string	必须