API說明
本文為您介紹AUI Kits智能體實(shí)時(shí)互動(dòng)場景的API說明。
創(chuàng)建客戶智能體實(shí)例
創(chuàng)建一個(gè)客戶的智能體實(shí)例，適用于AICallKit SDK集成方案和ARTC SDK集成方案。
使用說明
請求協(xié)議：http/https
請求Path：/api/v1/aiagent/GenerateAIAgentCall
是否需要授權(quán)：是
請求Method：POST
請求ContentType：JSON
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例值 | 描述 | |||
ai_agent_id | String | 否 | 39f8e0bc005e4f309379701645f4**** | 智能體ID | |||
expire | integer | 否 | 24 | 可選參數(shù)，表示token失效的時(shí)間，單位，默認(rèn)24小時(shí) | |||
user_id | String | 否 | useridxxxx | 用戶id | |||
template_config | String | 是 | {"VoiceChat": {"AppId": "your_voice_chat_app_id"}} | AIAgent模板配置 | |||
workflow_type | String | 否 | VoiceChat | 智能體實(shí)例類型：
| |||
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 | ||||
code | Integer | 200 | 業(yè)務(wù)響應(yīng)碼。參考HTTP響應(yīng)碼 | ||||
rtc_auth_token | String | rtc_auth_tokenxxx | RTC 授權(quán)token, 經(jīng)過base64編碼 | ||||
ai_agent_id | String | ai_agent_idxxxx | 智能體id | ||||
ai_agent_user_id | String | ai_agent_user_idxxxx | 智能體用戶id | ||||
channel_id | String | channel_idxxxx | 頻道id | ||||
workflow_type | String | VoiceChat | 智能體實(shí)例類型 | ||||
ai_agent_instance_id | String | ai_agent_instance_idxxx | 智能體實(shí)例ID | ||||
示例
請求示例
{
"ai_agent_id":"30040ed7740b42f4a944bf6xxxxx",
"expire": 24,
"user_id": "12345678xxxx",
"template_config":"{}",
"workflow_type": "VoiceChat"
}正常返回示例
{
"code": 200,
"rtc_auth_token": "eyJnc2xiIjpbImh0dHBzOi8vZ3cucnRuLmFsaXl1bmxxxxx",
"ai_agent_user_id":"xxx",
"channel_id": "fwfwqeqeqwewqxxx",
"workflow_type": "VoiceChat",
"ai_agent_id": "17e1c928bead40afb36f861d44c2fa0axxx",
"ai_agent_instance_id": "abcb1f5177b449329144b5f6578xxxx"
}啟動(dòng)智能體實(shí)例
啟動(dòng)一個(gè)RTC互動(dòng)AI智能體實(shí)例，并加入RTC通話，適用于ARTC SDK集成方案。
使用說明
請求協(xié)議：http/https
請求Path：/api/v1/aiagent/startAIAgentInstance
是否需要授權(quán)：是
請求Method：POST
請求ContentType：JSON
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例值 | 描述 | |||
user_id | String | 是 | useridxxxx | 用戶id | |||
template_config | String | 否 | {"xxx":"xx"} | AIAgent模板配置 | |||
workflow_type | String | 是 | VoiceChat | 智能體實(shí)例類型：
| |||
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 | ||||
code | Integer | 200 | 業(yè)務(wù)響應(yīng)碼。參考HTTP響應(yīng)碼 | ||||
ai_agent_instance_id | String | 513bbc1a2672*****1e2be | 智能體實(shí)例id | ||||
rtc_auth_token | String | xxxx | RTC 授權(quán)token, 經(jīng)過base64編碼 | ||||
ai_agent_user_id | String | xxxx | 智能體用戶id | ||||
channel_id | String | xxxx | 頻道id | ||||
示例
請求示例
{
"workflow_type":"VoiceChat",
"user_id": "12345xxxx",
"template_config":""
}正常返回示例
{
"code": 200,
"rtc_auth_token": "eyJnc2xiIjpbImh0dHBzOixxxx",
"ai_agent_instance_id": "30040ed7740b42f4a944bf6f5bxxx",
"ai_agent_user_id": "97fcfc0b6dc74601903e570c6a82xxx",
"channel_id": "5abcd61c4fa24ed79dc7c1cb4a64xxxx"
}停止智能體實(shí)例
停止一個(gè)RTC互動(dòng)AI智能體實(shí)例，適用于ARTC SDK集成方案。
使用說明
請求協(xié)議：http/https
請求Path：/api/v1/aiagent/stopAIAgentInstance
是否需要授權(quán)：是
請求Method：POST
請求ContentType：JSON
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例值 | 描述 | |||
ai_agent_instance_id | String | 是 | 513bbc1a2672*****1e2be | 需要停止的智能體實(shí)例ID | |||
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 | ||||
code | Integer | 200 | 業(yè)務(wù)響應(yīng)碼。參考HTTP響應(yīng)碼 | ||||
result | Boolean | true | 結(jié)果：true-成功；false-失敗 | ||||
示例
請求示例
{
"ai_agent_instance_id": "ff22f767-0471-4ef4-8aee-2xxxxxx"
}正常返回示例
{
"code": "200",
"result": true
}修改智能體實(shí)例配置
修改一個(gè)RTC互動(dòng)AI智能體實(shí)例配置，如音色、歡迎語等，適用于ARTC SDK集成方案。
使用說明
請求協(xié)議：http/https
請求Path：/api/v1/aiagent/updateAIAgentInstance
是否需要授權(quán)：是
請求Method：POST
請求ContentType：JSON
請求參數(shù)
名稱 | 類型 | 是否必填 | 示例值 | 描述 | |||
ai_agent_instance_id | String | 是 | 513bbc1a2672*****1e2be | 需要修改智能體實(shí)例ID | |||
template_config | String | 是 | {"xxx":"xx"} | AIAgent模板配置 | |||
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 | ||||
code | Integer | 業(yè)務(wù)響應(yīng)碼。參考HTTP響應(yīng)碼 | 業(yè)務(wù)響應(yīng)碼。參考HTTP響應(yīng)碼 | ||||
result | Boolean | true | 結(jié)果：true-成功；false-失敗 | ||||
示例
請求示例
{
"ai_agent_instance_id": "513bbc1a2672667bxxxx33b8fa0c9a88xxxxxx",
"template_config": "{\"xxx\":\"xxxx\"}"
}正常返回示例
{
"code": "200",
"result": true
}