返回一個意圖

調試

您可以在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. 指定的話術不存在。

訪問錯誤中心查看更多錯誤碼。