CreateSNSWeComEndpoint

Creates a WeCom endpoint, which is a WeCom robot. For example,

CreateSNSWeComEndpoint name=wecom url=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key\u003df8b9014a-207a-44d5-ae26-3501bf01dbc4 atPersonUserIds=+86-12900010002,+86-13977889933

Parameters

Name Description Optional Valid Value Starting Version
url The webhook URL of the WeCom robot. 5.0.0
atAll Whether to notify all (@All) members in a WeCom group. Yes 5.0.0
atPersonUserIds The ID of the group member to be notified (the @member). 5.0.0
name The name. For more information, see Resource Property. 5.0.0
description The description. For more information, see Resource Property. Yes 5.0.0
resourceUuid The resource uuid. Yes 5.0.0
userTags The user tags. For more information, see CreateUserTag. Yes 5.0.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 5.0.0
tagUuids The tag UUID list. Yes 5.0.0
atPersonList The @person information. (Recommend) Yes 5.0.0
timeout Yes
{
    "inventory": {
        "atAll": false,
        "atPersonList": [
            {
                "endpointUuid": "b6689ad75d194c3c9836304d8177f269",
                "userId": "+86-13977889933",
                "uuid": "66cef1c252784cfe98fbb056f5083477"
            },
            {
                "endpointUuid": "b6689ad75d194c3c9836304d8177f269",
                "userId": "+86-12900010002",
                "uuid": "af662f2230ab4cc7897169547f2e33d3"
            }
        ],
        "atPersonUserIds": [
            "+86-13977889933",
            "+86-12900010002"
        ],
        "createDate": "Feb 27, 2024 5:23:19 PM",
        "lastOpDate": "Feb 27, 2024 5:23:19 PM",
        "name": "wecom",
        "platform": {
            "createDate": "Jan 30, 2024 10:23:50 AM",
            "description": "this is used by endpoints which doesn't have own application platforms",
            "lastOpDate": "Jan 30, 2024 10:23:50 AM",
            "name": "system",
            "state": "Enabled",
            "type": "system",
            "uuid": "02d24b9b0a7f4ee1846f15cda248ceb7"
        },
        "platformUuid": "02d24b9b0a7f4ee1846f15cda248ceb7",
        "state": "Enabled",
        "type": "WeCom",
        "url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?keyu003df8b9014a-207a-44d5-ae26-3501bf01dbc4",
        "uuid": "b6689ad75d194c3c9836304d8177f269"
    },
    "success": true
}
  • url: the webhook URL of the WeCom robot
  • atAll: If set to true, all members in the WeCom group will be notified after a message is sent through WeCom, and the atPersonUserIds parameter will be ignored.
  • atPersonPhoneNumbers: the phone number of the group member to be notified (the @member). WeCom is registered with a phone number, through which you can notify (@) members in a target WeCom group.
    Note: WeCom displays phone numbers with country calling codes. You can check a complete phone number, such as +86-18977550789, by clicking the profile icon in FeiShu.
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center