查询收集表单

可通过接口获取机器人收集的表单

请求地址

https://{baseURL}/api/v1/aicall/form/query?appkey=[appkey]&nonce=[nonce]&timestamp=[timestamp]&signature=[signature]

请求方式：

POST

请求参数：

属性 类型 约束 描述 举例说明
page_no integer 选填 查询的页数 0
page_size integer 选填 每页查询的条数 10
call_type string 必填 呼叫类型，呼入传值:call_in，外呼传值：call_out
task_id string call_type为call_out时必填 外呼任务ID
call_id string call_type为call_in时必填 呼入通话ID
begin_at string 选填 任务创建的起始时间，格式为yyyyMMddHHmmss，通过begin_at和end_at查询时，task_id，call_id非必填，begin_at和end_at查询，时间跨度不超过一个月 如20240416142030
end_at string 选填 任务创建的结束时间，格式为yyyyMMddHHmmss，通过begin_at和end_at查询时，task_id，call_id非必填，begin_at和end_at查询，时间跨度不超过一个月 如20240416182030

请求示例

api/v1/aicall/number/query?appkey=[appkey]&nonce=[nonce]&timestamp=[timestamp]&signature=[signature]
Accept:application/json;
Content-Type: application/json;charset=utf-8;
{
    "page_no": 0,
    "page_size": 10,
    "call_type":"call_out",
    "task_id": "152602087204985"
}

响应包体：

属性 类型 说明
code integer 请求状态码，此时为0
msg string 请求状态码描述,此时为空
data object 结果集
data.task_id string 任务ID
data.name string 外呼任务名称
data.call_id string 呼叫id
data.called_number string 呼入是主叫号码;外呼是被叫号码
data.tag_array array 意向标签组
data.call_status integer 呼叫状态
data.form_info array 表单信息
data.form_info.var_name string 变量名称
data.form_info.var_key string 变量Key
data.form_info.var_desc string 变量描述
data.form_info.var_get_value string 变量收集值

响应示例：

HTTP/1.1 200 OK
{
    "code": 0,
    "msg": "success",
    "data": {
        "total_count": 1,
        "page_count": 1,
        "cur_page": 1,
        "page_size": 1,
        "list": [
            {
                "call_id": "7fb7d8dd-68be-4049-8f0a-dvdd558f8ca0",
                "called_number": "1731053670",
                "tag_array": [
                    "A级 (有明确意向)"
                ],
                "call_status": 1,
                "form_info": [
                    {
                        "var_name": "字段名称1",
                        "var_key": "变量key1",
                        "var_desc": "变量描述1",
                        "var_get_value": "变量收集value1"
                    },
                    {
                        "var_name": "字段名称2",
                        "var_key": "变量key2",
                        "var_desc": "变量描述2",
                        "var_get_value": "变量收集value2"
                    }
                ]
            }
        ]
    }
}
文档更新时间: 2024-11-01 17:33   作者：admin