DescribeIntent - 获取一个意图-旧画布接口

获取一个意图,旧画布接口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
outboundbot:DescribeIntentget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID

da37319b-6c83-4268-9f19-814aed62e401
ScriptIdstring

场景 ID

aa279896-64a6-4182-864c-4f2b04ec8d17
IntentIdstring

意图 ID

10717802

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码

200
Codestring

响应码

OK
Messagestring

接口提示消息

Success
RequestIdstring

请求 ID

327FEE69-F173-5B2F-9F3B-DCC6182D7BA0
Successboolean

请求成功与否标识。

true
Intentobject

意图信息

Utterancesstring

触发意图的用户表述列表

["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]
IntentDescriptionstring

实例描述

同意还款意图
UpdateTimelong

更新时间

1578469042851
CreateTimelong

创建时间

1578469042851
Keywordsstring

意图的关键字,在 List 接口可用于过滤查找的意图

["还款"]
ScriptIdstring

场景 ID

6ef95fd5-558f-4ee8-af34-b2ede087a87c
IntentIdstring

意图 ID

10722701
IntentNamestring

意图名称

统一还款

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "327FEE69-F173-5B2F-9F3B-DCC6182D7BA0",
  "Success": true,
  "Intent": {
    "Utterances": [
      "ok",
      "好的",
      "好吧",
      "好嘞",
      "可以",
      "行啊",
      "行吧",
      "那行",
      "知道了",
      "我看一下",
      "能的",
      "等会吧",
      "等一下",
      "马上还",
      "等一会",
      "过两天",
      "我会想办法处理"
    ],
    "IntentDescription": "同意还款意图",
    "UpdateTime": 1578469042851,
    "CreateTime": 1578469042851,
    "Keywords": [
      "还款"
    ],
    "ScriptId": "6ef95fd5-558f-4ee8-af34-b2ede087a87c",
    "IntentId": 10722701,
    "IntentName": "统一还款"
  }
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
404NotExist.ScriptThe specified Script does not exist.指定的话术不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史