跳到主要内容
版本:2.0.0

用平台测试对话接口能力

打开开放平台

点击平台手册左上方工具栏的“开放平台”,选择服务端接口,将在新页面打开服务端开放平台接口列表页。 1 2

常用接口调用方法

创建新用户

  • 选择ChannelUserService下的操作多个渠道用户接口/chatbot/v1alpha1/agents/{agentId}/channels/{channelId}/users/mutate3
  • 点击“Try It Out”,填写各配置项。 4
    • 机器人id、渠道id的查找方式详见通过开放平台创建用户并收发消息5
    • 以下是body部分的一个示例:
      {
      "operations": [
      {
      "create": {
      "username": "这里是用户名",
      "nickname": "这里是用户昵称",
      "avatarUrl": "https://newtestchatbot.wul.ai/help/zh/img/logo_large.png"
      }
      }
      ]
      }
  • 点击“Execute”,则在对话平台的“监控-日志分析-用户日志”页面,可以查看到通过API创建的新用户。 6

获取回复

调用该接口时,需要在机器人内有创建好的技能。创建方法详见创建技能

  • 选择ChannelRelpyService下的获取回复接口/chatbot/v1alpha1/agents/{agentId}/channels/{channelId}/environments/{environment}/getReply7
  • 点击“Try It Out”,填写各配置项。 8
    • 机器人id、渠道id的查找方式详见通过渠道进行消息收发
    • 若当前版本未发布,可将environment字段配制成“SKETCH”;若已发布,则配制成“PRODUCT”。 9 以下是body部分的一个示例:
       {
      "username": "这里是用户名",
      "query": {
      "text": {
      "content": "宝宝发烧了"
      }
      }
      }
  • 点击“Execute”,在下方的“Response body”部分可以看到机器人给出了预设的答复。 10
  • 同时,在对话平台的“监控-日志分析”的相关页面,可以看到消息日志与用户日志写入了新的数据。 111213
note

在未创建用户的情况下调用该接口,机器人同样可以给出预设的回复,但对话数据无法写入日志。