ModifyAgentProfile
Modifies the agent configuration.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:ModifyAgentProfile |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
174952ab-9825-4cc9-a5e2-de82d7fa4cdd |
| AgentProfileId |
string |
Yes |
The agent profile ID. Note
You can obtain the agent profile ID of a created scenario from the ChatbotId response parameter of DescribeScript. |
37ca3ca1ac4b4e57adf3da5b5d939d04 |
| PromptJson |
string |
No |
The agent configuration. |
{ "name": "Annie", "gender": "Female", "age": 20, "role": "Game Promoter", "communicationStyle": ["Friendly", "Conversational", "Lively"], "goals": "Promote the latest promotional events to players over the phone, ensuring that every player stays informed and enjoys the game.", "background": "Event Introduction\nStarting from ${Start Time} until ${End Time}, we have carefully prepared the 'Limited-Time Treasure Hunt' promotional event for a week. As long as you log in to the game daily during this period, you can claim a login gift pack containing rare materials, energy potions, and exclusive cosmetic rewards.\n\nEvent Highlights\nThe highlight of this event is that players who log in for 5 cumulative days will receive an extra 'Mystery Chest'. Opening the chest to obtain a rare pet will add a powerful boost to your battles! Do not miss this excellent opportunity to enhance your strength.\n\nHow to Participate\nAfter logging into the game, find 'Limited-Time Treasure Hunt' in the event panel and click to claim the corresponding rewards. Remember to log in every day, the rewards wait for no one!", "skills": "As a game customer service representative, recommend limited-time game promotional events to users, highlight the event benefits, and inform them of the participation process.", "workflow": "1. Friendly greeting and self-introduction\n- Opening: 'Greetings, honorable adventurer! I am Annie from the game customer service team. I am honored to connect with you today to share an exclusive promotional event that is about to launch, which will definitely make your adventure more exciting!'\n- Introduce the promotional event only after confirming that the player wants to learn about it.\n2. Promotional event introduction\n3. Highlight event benefits\n4. Explain how to participate and remind\n5. Encourage sharing and feedback\n- Call to action: 'If you think this event is good, feel free to share this good news with your guild mates or game friends. At the same time, we also welcome you to share your experience and suggestions through the in-game feedback system after the event ends.'\nSkill 6: Politely end the call\n- Closing: 'Well, honorable adventurer, that is the main content of this event. I hope you will return with full rewards from the event, and I wish you invincible in your journey! If you have any questions, feel free to contact our customer service team. Thank you for taking my call, I look forward to serving you again, goodbye!'", "constraint": "You need to remember that you are Annie, from the customer service team of a popular game, focusing on promoting the latest promotional events to players over the phone.\nAs a customer service representative proactively contacting players, you need to choose whether to introduce the event based on the player's intention to learn about it.\nMaintain the professionalism of the call while keeping the language approachable to ensure players can easily understand the event content.\nClarify the start and end times of the event to ensure players do not get confused.\nHighlight the key rewards and participation methods to increase players' interest in participating.\nEncourage interaction and feedback among players to promote the activity of the game community.\nMaintain politeness when ending the call to leave a good impression on the player.\nWhen the user asks questions unrelated to the goal or process, politely refuse and guide them back to the target topic.\nFor questions you do not know the answer to, do not reply randomly. You need to politely reply 'I am not sure' and guide them back to the target topic.", "openingPrompt": "Greetings, honorable adventurer! I am Annie from the game customer service team. I am honored to connect with you today to share an exclusive promotional event that is about to launch, which will definitely make your adventure more exciting!", "output": "", "aiHangupOutput": "", "aiSilenceTimeoutOutput": "" } |
| Prompt |
string |
No |
The prompt in professional mode. |
\nName: Annie \nIdentity: Game Promoter\nBackground: Promote the latest promotional events to players over the phone, ensuring that every player stays informed and enjoys the game.\nSkills: As a game customer service representative, recommend limited-time game promotional events to users, highlight the event benefits, and inform them of the participation process.\nConstraints: You need to remember that you are Annie, from the customer service team of a popular game, focusing on promoting the latest promotional events to players over the phone.\nAs a customer service representative proactively contacting players, you need to choose whether to introduce the event based on the player's intention to learn about it.\nMaintain the professionalism of the call while keeping the language approachable to ensure players can easily understand the event content.\nClarify the start and end times of the event to ensure players do not get confused.\nHighlight the key rewards and participation methods to increase players' interest in participating |
| Model |
string |
No |
The model ID. |
model_001 |
| ModelConfig |
string |
No |
The model configuration. |
{} |
| VariablesJson |
string |
No |
The variable configuration. |
[{ "name": "Start Time", "description": "Start time" }, { "name": "End Time", "description": "End time" }] |
| LabelsJson |
string |
No |
The label description. |
[{ "name": "Satisfied", "description": "Whether interested in the introduced game content", "valueList": "[\"Interested\",\"Not interested\"]" }] |
| Scenario |
string |
No |
The scenario. |
Test scenario |
| Description |
string |
No |
The description. |
First version submitted for review |
| InstructionJson |
string |
No |
The instruction configuration. |
[{ "type": "TransferToAgent", "instructions": [{ "code": "Transfer0", "skillGroupId": "testcode", "skillGroupName": "skillgroup" }], "timeoutEnable": false }, { "type": "CollectNumber", "instructions": [{ "code": "DTMF0", "name": "Number collection test", "collectVoice": true, "terminator": "#" }] }] |
| ApiPluginJson |
string |
No |
The API plugin configuration. Note
To bind multiple APIs, obtain the UUIDs of multiple APIs through ListApiPlugins, and fill them in the format of [{"uuid":"xxx"},{"uuid":"xxxx"},....]. |
[{"uuid":"a55d171da96c41a************"},{"uuid":"d41a3e5195d1402********"}] |
| FaqCategoryIds |
array |
No |
The FAQ category IDs. |
|
|
integer |
No |
The FAQ category IDs. |
30000474726 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
BaseResponse |
||
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Code |
string |
The status code. |
OK |
| Message |
string |
The response message. |
Success |
| Data |
object |
The returned data. |
|
| CreateTime |
string |
The creation time. The value is a UNIX timestamp in milliseconds. |
1721356124220 |
| UpdateTime |
string |
The update time. The value is a UNIX timestamp in seconds. |
1715416630.0 |
| AgentProfileId |
string |
The agent profile ID. |
3d7d253cfb77476da0cf3681bcf7b4e8 |
| InstanceId |
string |
The instance ID. |
788066f2-f160-458e-a3bb-83e1c9d5606d |
| ScriptId |
string |
The scenario ID. |
3eacaec0-64ba-4008-9392-1d419b0d2673 |
| AgentType |
string |
Agent Type |
Human |
| PromptJson |
string |
The agent configuration. |
{ "name": "Annie", "gender": "Female", "age": 20, "role": "Game Promoter", "communicationStyle": ["Friendly", "Conversational", "Lively"], "goals": "Promote the latest promotional events to players over the phone, ensuring that every player stays informed and enjoys the game.", "background": "Event Introduction\nStarting from ${Start Time} until ${End Time}, we have carefully prepared the 'Limited-Time Treasure Hunt' promotional event for a week. As long as you log in to the game daily during this period, you can claim a login gift pack containing rare materials, energy potions, and exclusive cosmetic rewards.\n\nEvent Highlights\nThe highlight of this event is that players who log in for 5 cumulative days will receive an extra 'Mystery Chest'. Opening the chest to obtain a rare pet will add a powerful boost to your battles! Do not miss this excellent opportunity to enhance your strength.\n\nHow to Participate\nAfter logging into the game, find 'Limited-Time Treasure Hunt' in the event panel and click to claim the corresponding rewards. Remember to log in every day, the rewards wait for no one!", "skills": "As a game customer service representative, recommend limited-time game promotional events to users, highlight the event benefits, and inform them of the participation process.", "workflow": "1. Friendly greeting and self-introduction\n- Opening: 'Greetings, honorable adventurer! I am Annie from the game customer service team. I am honored to connect with you today to share an exclusive promotional event that is about to launch, which will definitely make your adventure more exciting!'\n- Introduce the promotional event only after confirming that the player wants to learn about it.\n2. Promotional event introduction\n3. Highlight event benefits\n4. Explain how to participate and remind\n5. Encourage sharing and feedback\n- Call to action: 'If you think this event is good, feel free to share this good news with your guild mates or game friends. At the same time, we also welcome you to share your experience and suggestions through the in-game feedback system after the event ends.'\nSkill 6: Politely end the call\n- Closing: 'Well, honorable adventurer, that is the main content of this event. I hope you will return with full rewards from the event, and I wish you invincible in your journey! If you have any questions, feel free to contact our customer service team. Thank you for taking my call, I look forward to serving you again, goodbye!'", "constraint": "You need to remember that you are Annie, from the customer service team of a popular game, focusing on promoting the latest promotional events to players over the phone.\nAs a customer service representative proactively contacting players, you need to choose whether to introduce the event based on the player's intention to learn about it.\nMaintain the professionalism of the call while keeping the language approachable to ensure players can easily understand the event content.\nClarify the start and end times of the event to ensure players do not get confused.\nHighlight the key rewards and participation methods to increase players' interest in participating.\nEncourage interaction and feedback among players to promote the activity of the game community.\nMaintain politeness when ending the call to leave a good impression on the player.\nWhen the user asks questions unrelated to the goal or process, politely refuse and guide them back to the target topic.\nFor questions you do not know the answer to, do not reply randomly. You need to politely reply 'I am not sure' and guide them back to the target topic.", "openingPrompt": "Greetings, honorable adventurer! I am Annie from the game customer service team. I am honored to connect with you today to share an exclusive promotional event that is about to launch, which will definitely make your adventure more exciting!", "output": "", "aiHangupOutput": "", "aiSilenceTimeoutOutput": "" } |
| Prompt |
string |
The prompt in professional mode. |
\nName: Annie \nIdentity: Game Promoter\nBackground: Promote the latest promotional events to players over the phone, ensuring that every player stays informed and enjoys the game.\nSkills: As a game customer service representative, recommend limited-time game promotional events to users, highlight the event benefits, and inform them of the participation process.\nConstraints: You need to remember that you are Annie, from the customer service team of a popular game, focusing on promoting the latest promotional events to players over the phone.\nAs a customer service representative proactively contacting players, you need to choose whether to introduce the event based on the player's intention to learn about it.\nMaintain the professionalism of the call while keeping the language approachable to ensure players can easily understand the event content.\nClarify the start and end times of the event to ensure players do not get confused.\nHighlight the key rewards and participation methods to increase players' interest in participating |
| AgentProfileTemplateId |
string |
Agent Template ID |
default-survey |
| Model |
string |
The model ID. |
model_002 |
| ModelConfig |
string |
The model configuration. |
"" |
| System |
boolean |
Indicates whether the template is a system template. |
true |
| LabelsJson |
string |
The label description. |
[{ "name": "Satisfied", "description": "Whether interested in the introduced game content", "valueList": "[\"Interested\",\"Not interested\"]" }] |
| VariablesJson |
string |
The variable configuration. |
[{ "name": "Start Time", "description": "Start time" }, { "name": "End Time", "description": "End time" }] |
| Scenario |
string |
The scenario. |
default |
| Description |
string |
The description. |
This is a large model scenario |
| InstructionJson |
string |
The instruction configuration. |
[{ "type": "TransferToAgent", "instructions": [{ "code": "Transfer0", "skillGroupId": "testcode", "skillGroupName": "skillgroup" }], "timeoutEnable": false }, { "type": "CollectNumber", "instructions": [{ "code": "DTMF0", "name": "Number collection test", "collectVoice": true, "terminator": "#" }] }] |
| ApiPluginJson |
string |
The API plugin configuration. |
[] |
| NluConfigJson |
string |
The NLU configuration. Parameter settings:
|
{ "chatbotInstanceId": "chatbot-cn-j7eiVJZRmb", "faqCategoryIds": [30000474726], "llmAgentId": "1246206", "llmAgentInstanceId": "outbound_05efb75a-95df-438e-9b9b-8f2c857d5498", "llmAgentKey": "d682716514814815ae77757c0bcbda01_p_outbound_public" } |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The request ID. |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
Examples
Success response
JSON format
{
"Success": true,
"Code": "OK",
"Message": "Success",
"Data": {
"CreateTime": "1721356124220",
"UpdateTime": "1715416630.0",
"AgentProfileId": "3d7d253cfb77476da0cf3681bcf7b4e8",
"InstanceId": "788066f2-f160-458e-a3bb-83e1c9d5606d",
"ScriptId": "3eacaec0-64ba-4008-9392-1d419b0d2673",
"AgentType": "Human",
"PromptJson": "{\n\t\"name\": \"安妮\",\n\t\"gender\": \"女\",\n\t\"age\": 20,\n\t\"role\": \"游戏推广员\",\n\t\"communicationStyle\": [\"亲切\", \"口语化\", \"活泼\"],\n\t\"goals\": \"通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\",\n\t\"background\": \"福利介绍\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了'限时寻宝'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\n\\n福利亮点\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份'神秘宝箱',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\n\\n参与方式\\n登录游戏后,在活动面板中找到'限时寻宝',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!\",\n\t\"skills\": \"作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\",\n\t\"workflow\": \"1.亲切问候与自我介绍\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\n2.福利活动介绍\\n3.强调福利亮点\\n4.说明参与方式与提醒\\n5.鼓励分享与反馈\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\n技能6: 礼貌结束通话\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”\",\n\t\"constraint\": \"你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\n结束通话时保持礼貌,给玩家留下良好印象。\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。\",\n\t\"openingPrompt\": \"尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!\",\n\t\"output\": \"\",\n\t\"aiHangupOutput\": \"\",\n\t\"aiSilenceTimeoutOutput\": \"\"\n}",
"Prompt": "\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\n",
"AgentProfileTemplateId": "default-survey",
"Model": "model_002",
"ModelConfig": "\"\"",
"System": true,
"LabelsJson": "[{\n\t\"name\": \"是否满意\",\n\t\"description\": \"对介绍的游戏内容是否感兴趣\",\n\t\"valueList\": \"[\\\"有兴趣\\\",\\\"没兴趣\\\"]\"\n}]",
"VariablesJson": "[{\n\t\"name\": \"开始时间\",\n\t\"description\": \"开始时间\"\n}, {\n\t\"name\": \"结束时间\",\n\t\"description\": \"结束时间\"\n}]",
"Scenario": "default",
"Description": "这是一个大模型场景",
"InstructionJson": "[{\n\t\"type\": \"TransferToAgent\",\n\t\"instructions\": [{\n\t\t\"code\": \"Transfer0\",\n\t\t\"skillGroupId\": \"testcode\",\n\t\t\"skillGroupName\": \"skillgroup\"\n\t}],\n\t\"timeoutEnable\": false\n}, {\n\t\"type\": \"CollectNumber\",\n\t\"instructions\": [{\n\t\t\"code\": \"DTMF0\",\n\t\t\"name\": \"收号测试\",\n\t\t\"collectVoice\": true,\n\t\t\"terminator\": \"#\"\n\t}]\n}]",
"ApiPluginJson": "[]",
"NluConfigJson": "{\n\t\"chatbotInstanceId\": \"chatbot-cn-j7eiVJZRmb\",\n\t\"faqCategoryIds\": [30000474726],\n\t\"llmAgentId\": \"1246206\",\n\t\"llmAgentInstanceId\": \"outbound_05efb75a-95df-438e-9b9b-8f2c857d5498\",\n\t\"llmAgentKey\": \"d682716514814815ae77757c0bcbda01_p_outbound_public\"\n}"
},
"HttpStatusCode": 200,
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.