# 接入智能对话

接入之前，需要先在对话平台官网创建机器人，并在应用绑定中申请开放 API 的接入参数。 例如：

APPID: Gg8HejYTkUsEIlG
Token: YV78Pyj1VvqdNGpMJ1pHic0bIBOWMv
AESKey: q1Os1ZMe0nG28KUEx9lg3HjK7V5QyXvi212fzsgDqgz

参数说明：

• APPID：和机器人一一对应，和 Token、AESKey 对应。
• Token：用于签名，签名不通过的请求将拒绝响应。
• AESKey：用于对 body 数据进行对称加解密，加解密算法为 AESCBC 算法。

# 1. 安全性

# 1.1 数据加密

如果需要加密传输的接口，则使用 AESKey 进行对称加密。请求的 body 数据会解密后再处理，响应的数据也需要解密后，才可以得到下文的示例响应。 如果接口需要加密传输，将会特殊说明。

具体算法细节可参考 第三方服务接口 中“加密”一栏的介绍。

# 1.2 签名

每一个请求都需要签名。签名需要使用上文申请的Token,具体的签名方法：

sign = md5(Token + str(unix_timestamp) + nonce + md5(body))

GET 请求的 body 为空

md5 为小写的 hex 格式。

具体字段下文有说明。

例如：

Token:YV78Pyj1VvqdNGpMJ1pHic0bIBOWMv
unix_timestamp:1711001766
nonce:abc
body:空
sign:fff8dae1356e7867ea98743439f0e9f8

# 2. 公共参数

# 2.1. 请求参数

# header 参数

几乎所有请求都应该携带这些 header。 X-APPID 仅在换取 X-OPENAI-TOKEN 的时候携带，后续都携带 X-OPENAI-TOKEN。X-OPENAI-TOKEN 仅 2h 有效，过期后应该更换新的。（X-APPID 和 X-OPENAI-TOKEN 二选一）

# 请求参数

部分查询接口支持分页参数。

# 2.2. 响应参数

# 2.3. 错误码

# 3. 换取 Accesstoken

# 功能说明

通过 appid，account 换取一个 2 小时有效的 换取 Accesstoken，用于后续的请求的身份校验，后面带到 header:X-OPENAI-TOKEN 中。

# 请求 uri

/v2/token

# 请求类型

POST

# 请求参数

# params

# 返回参数

如果签名校验不通过，http status code 是 400。

# 示例

• 请求示例

curl -X POST \
  https://openaiapi.weixin.qq.com/v2/token \
  -H 'X-APPID: Gg8HejYTkUsEIlG' \
  -H 'request_id:54ae04cf-5e95-44fd-ad3f-62e7b163836b' \
  -H 'timestamp:1711001766' \
  -H 'nonce:abc' \
  -H 'sign:通过sign=md5(Token+str(unix_timestamp)+nonce+md5(body))生成' \
  -H 'content-type: application/json' \
  -d '{
    "account":"fb2ab07ce06"
}'

• 正确返回示例

{
  "code": 0,
  "data": {
    "access_token": "MX6ddM5mN07ucVKy+Y-to7tKRufZ1YF05eb542d5170000001c"
  },
  "msg": "success",
  "request_id": "54ae04cf-5e95-44fd-ad3f-62e7b163836b"
}

• 错误返回示例

{
  "code": 110002,
  "msg": "参数错误，缺少必要参数，或参数不正确",
  "request_id": "54ae04cf-5e95-44fd-ad3f-62e7b163836b"
}

# 4. 接口索引

# 5. 附录

下载 postman 请求示例文件

# 6. 常见问题

1. 如何反馈 bug？

   提供请求的接口、request_id、问题描述、发生时间点等信息反馈给我们。