BindPolarClawAgent
Associates a specified channel with a specific PolarClaw agent.
Operation description
Request description
This API operation associates a PolarClaw agent (specified by AgentId) of a PolarClaw application (identified by ApplicationId) with a given communication channel (Channel). If necessary, you can also specify the account ID (ChannelAccountId) within the channel.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
polardb:BindPolarClawAgent |
create |
*All Resource
|
None | None |
Request syntax
POST HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ApplicationId |
string |
Yes |
The application ID. You can call the DescribeApplications operation to obtain the application ID from the returned Items list. |
pa-************** |
| AgentId |
string |
Yes |
The ID of the agent to associate. |
work |
| Channel |
string |
Yes |
The channel plugin ID. |
feishu |
| ChannelAccountId |
string |
No |
The channel account ID. If you do not specify this parameter, the default value is default. |
default |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
successful |
successful |
| Code |
integer |
200 |
200 |
| ApplicationId |
string |
The application ID. |
pa-******************** |
| AgentId |
string |
Agent ID |
work |
| Binding |
object |
The details of the newly created association. |
|
| AgentId |
string |
Agent ID |
work |
| Channel |
string |
The channel ID. |
feishu |
| AccountId |
string |
The account ID. |
default |
| TotalBindings |
integer |
The total number of global associations after the operation. |
1 |
Examples
Success response
JSON format
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-********************",
"AgentId": "work",
"Binding": {
"AgentId": "work",
"Channel": "feishu",
"AccountId": "default"
},
"TotalBindings": 1
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.