异步调用自有分析程序 - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

服务端API

数据与智能专区

专区程序调用sdk

异步调用自有分析程序

最后更新：2024/07/29

创建自有分析程序任务

获取自有分析程序结果

开发者可调用本接口传入会话内容，使用自己上传的分析程序进行会话分析。

详细说明

该接口仅支持分析文本消息

程序的输入协议由管理端的配置决定，除自定义文本外，还可以使用以下1项数据：

会话内容
识别并替换占位符 {chat}，将传入的msg_list对应的会话分行拼接，示例：
```
A说：今天天气真不错！
B说：确实呀！
```
识别并替换占位符 {chatcontent}，将传入的msg_list对应的会话内容填入（不包含发送者），示例：
```
今天天气真不错！
确实呀！
```

以下提供一个输入协议与输出协议示例，以供参考。
输入协议：

{"ability_id":"1", "task_type":"service_statistics", "msg": "{chat}"}

输出协议：

{"avg_reply_time": 8, "negative_feedback_cnt": 5}

权限说明

应用类型	权限要求
自建应用	需具备「数据与智能专区权限」
代开发应用	需具备「数据与智能专区权限」
第三方应用	需具备「数据与智能专区权限」

创建自有分析程序任务

请求方法
通过SDK调用，具体方式参考专区程序使用指引。

请求接口名：
create_program_task

请求包体：

{
	"program_id": "PROG_ID",
	"ability_id": "ABILITY_ID",
    "msg_list":[{
        "msgid": "MSGID1",
        "encrypt_info":{
            "secret_key": "SECRETKEY1"
        }
    },{
        "msgid": "MSGID2",
        "encrypt_info":{
            "secret_key": "SECRETKEY2"
        }
    }],
	"debug_info":{
		"chat":"xxx",
		"chat_content":"xxx"
	}
}

参数说明：

参数	是否必须	说明
program_id	是	应用关联的程序id
ability_id	是	能力id
msg_list	是	消息列表，最多1000个
msg_list.msgid	是	每条消息对应的msgid。多次出现同一个msgid，以首次出现的为准
msg_list.encrypt_info.secret_key	是	该消息的密钥，将encrypted_secret_key用RSA私钥解密后得到
debug_info	否	仅当处于调试模式时生效，将使用此字段下的内容而不是实际的消息来替换对应的占位符。在调试模式下，即使未填写，msg_list字段中填写的内容也将被忽略。请注意，在调试模式下，msg_list内填写的内容将被忽略，但为了保证流程的一致性，此时msg_list字段仍然是必填字段。
debug_info.chat	是	将用于替换{chat}占位符
debug_info.chat_content	是	将用于替换{chatcontent}占位符

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "jobid": "JOBID",
    "fail_list":[
        {
            "errcode": 710601,
            "errmsg": "xxx",
            "msgid": "MSGID2",
            "encrypt_info":{
                "secret_key": "SECRETKEY2"
            }
        }
    ]
}

参数说明：

参数	说明
errcode	错误码
errmsg	错误码说明
jobid	任务id。首次提交时返回
fail_tag_group_id_list	非法的客户标签组id列表
fail_list	提交出错的消息列表，只有msgid重复项返回至该列表，详见FailMsg说明

FailMsg说明：

参数	说明
errcode	错误码
errmsg	错误码说明
msgid	每条消息对应的msgid，与入参对应
encrypt_info	每条消息对应的加密信息，与入参对应
encrypt_info.secret_key	加密消息用的secret_key

获取自有分析程序结果

请求方法
通过SDK调用，具体方式参考专区程序使用指引。

请求接口名：
get_program_task_result

请求包体：

{
    "jobid": "JOBID"
}

参数说明：

参数	是否必须	说明
jobid	是	任务id

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "fail_list":[{
        "errcode": 710601,
        "errmsg": "xxx",
        "msgid": "MSGID"
    }],
	"response_errcode": 0,
	"response_data": "{\"output\":\"xxx\"}"
}

参数说明：

参数	说明
errcode	错误码
errmsg	错误码说明
fail_list	错误的消息列表，如msgid不存在、非文本等，详见“创建自有分析程序任务”的FailMsg说明
response_errcode	专区程序返回的错误码
response_data	专区程序的输出结果，为自定义的JSON字符串