返回一个意图

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeIntent

系统规定参数。取值：DescribeIntent。
InstanceId String 是 af81a389-91f0-4157-8d82-720edd02b66a

实例id
IntentId String 是 0f8a0059-dc9c-4151-8378-4734bbadf3cc

查询的意图id
ScriptId String 是 b9ff4e88-65f9-4eb3-987c-11ba51f3f24d

意图所在的话术id

返回数据

名称 类型 示例值 描述
Code String OK

接口状态码
HttpStatusCode Integer 200

http 状态码
Intent Struct

意图信息
CreateTime Long 1578469042851

创建时间
IntentDescription String 同意还款意图

意图描述
IntentId String a8494b35-eefb-4c8a-887b-b60d2f0fa57a

意图id
IntentName String 统一还款

意图名字
Keywords String ["还款"]

意图关键字，
ScriptId String 6ef95fd5-558f-4ee8-af34-b2ede087a87c

话术id
UpdateTime Long 1578469042851

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

触发意图的用户表述列表
Message String Success

接口提示信息
RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

请求id
Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeIntent
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&IntentId=0f8a0059-dc9c-4151-8378-4734bbadf3cc
&ScriptId=b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
&<公共请求参数>

正常返回示例

XML 格式 

<code>OK</code>
<httpStatusCode>200</httpStatusCode>
<intent>
    <createTime>0</createTime>
    <description/>
    <id/>
    <keywords/>
    <name/>
    <scriptId/>
    <updateTime>0</updateTime>
    <utterances/>
</intent>
<message/>
<requestId/>
<success>true</success>

JSON 格式 

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

错误码

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

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