Create a WeCom Endpoint
Headers
Authorization: OAuth the-session-uuidBody
{
"params": {
"url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4",
"atAll": false,
"atPersonUserIds": [
"18900002222",
"13377778888"
],
"atPersonList": {
"13377778888": "jack"
},
"name": "wecom"
},
"systemTags": [],
"userTags": []
}In the example above, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"url":"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4","atAll":false,"atPersonUserIds":["18900002222","13377778888"],"atPersonList":{"13377778888":"jack"},"name":"wecom"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/we-comParameter List
| Name | Type | Location | Description | Allowed Values | Starting Version |
|---|---|---|---|---|---|
| url | String | body (contained in the params structure) | WeCom chatbot webhook URL | 4.2.0 | |
| atALL (optional) | Boolean | body (contained in the params structure) | Whether to mention all members | 4.2.0 | |
| atPersonUserIds | List | body (contained in the params structure) | Mentioned users (user_id) | 4.2.0 | |
| name | String | body (contained in the params structure) | Resource name | 4.2.0 | |
| description (optional) | String | body (contained in the params structure) | Detailed description of the resource | 4.2.0 | |
| resourceUuid (optional) | String | body (contained in the params structure) | Resource UUID | 4.2.0 | |
| tagUuids (optional) | List | body (contained in the params structure) | Tag UUID list | 4.2.0 | |
| systemTags (optional) | List | body | System tags | 4.2.0 | |
| userTags (optional) | List | body | User tags | 4.2.0 | |
| atPersonList | Map | body (contained in the params structure) | Mentioned user information (recommended) | 4.2.0 |
API Response
Response Example
{
"inventory": {
"url": "http://wecom-url",
"atAll": false,
"name": "example",
"uuid": "917fe66f76b241f0843dfbd6be685fc1",
"description": "description example",
"type": "Email",
"state": "Enabled",
"platformUuid": "4eb0ceebf95b452585ebeacd647d9f35",
"createDate": "Mar 26, 2024 2:44:19 AM",
"lastOpDate": "Mar 26, 2024 2:44:19 AM"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 4.2.0 | |
| error | ErrorCode | The error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error | 4.2.0 |
| inventory | SNSWeComEndpointInventory | For details, see inventory | 4.2.0 |
error
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001. | 5.0.0 |
| description | String | A brief description of the error | 5.0.0 |
| details | String | Detailed information about the error | 5.0.0 |
| elaboration | String | Reserved field. Default is null. | 5.0.0 |
| opaque | LinkedHashMap | Reserved field. Default is null. | 5.0.0 |
| cause | ErrorCode | The root error. The source error that caused the current error. If there is no root error, this field is null. | 5.0.0 |
inventory
| Name | Type | Description | Starting Version |
|---|---|---|---|
| url | String | WeCom chatbot webhook URL | 4.2.0 |
| atAll | boolean | Whether to mention all members | 4.2.0 |
| atPersonUserIds | List | Mentioned user IDs | 4.2.0 |
| name | String | Resource name | 4.2.0 |
| uuid | String | The UUID of the resource. Uniquely identifies the resource. | 4.2.0 |
| description | String | Detailed description of the resource | 4.2.0 |
| type | String | Endpoint type | 4.2.0 |
| state | String | State | 4.2.0 |
| platformUuid | String | Application platform UUID | 4.2.0 |
| createDate | Timestamp | Creation time | 4.2.0 |
| lastOpDate | Timestamp | Last modification time | 4.2.0 |
| platform | SNSApplicationPlatformInventory | For details, see platform | 4.2.0 |
platform
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The UUID of the resource. Uniquely identifies the resource. | 5.0.0 |
| name | String | Resource name | 5.0.0 |
| description | String | Detailed description of the resource | 5.0.0 |
| type | String | Type | 5.0.0 |
| createDate | Timestamp | Creation time | 5.0.0 |
| lastOpDate | Timestamp | Last modification time | 5.0.0 |
SDK Examples
Java SDK
CreateSNSWeComEndpoint action = new CreateSNSWeComEndpoint();
action.url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key\u003df8b9014a-207a-44d5-ae26-3501bf01dbc4";
action.atAll = false;
action.atPersonUserIds = asList("18900002222","13377778888");
action.name = "wecom";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateSNSWeComEndpoint.Result res = action.call();Python SDK
CreateSNSWeComEndpoint action = new CreateSNSWeComEndpoint()
action.url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key\u003df8b9014a-207a-44d5-ae26-3501bf01dbc4"
action.atAll = false
action.atPersonUserIds = asList("18900002222","13377778888")
action.name = "wecom"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateSNSWeComEndpoint.Result res = action.call()