tencent cloud

Feedback

DescribeWebHookRules

Last updated: 2024-08-27 11:38:20

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to obtain the list of WeCom chatbot rules.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeWebHookRules.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Filter.N No Array of Filter Filter criteria
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
Order No String Sorting Method: [ASC: Ascending Order, DESC: Descending Order]
By No String Sorting field

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number
List Array of WebHookRuleSummary Rule content
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining the List of WeCom Chatbot Rules

This example shows you how to obtain the list of WeCom chatbot rules.

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebHookRules
<Common request parameters>

{
    "Filter": [],
    "Offset": 0,
    "Limit": 1,
    "Order": "",
    "By": ""
}

Output Example

{
    "Response": {
        "List": [
            {
                "RuleId": 55,
                "RuleName": "Test chatbot",
                "HookAddr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abe03861-a7c6-49cf-a12c-443c34be0db5",
                "RuleRemark": "",
                "RuleItems": [
                    {
                        "Type": 24,
                        "ControlBit": "1"
                    }
                ],
                "HostLabels": [],
                "HostCount": 0,
                "IsDisabled": 1,
                "CreateTime": "2023-02-17T18:41:03+08:00",
                "UpdateTime": "2023-02-28T10:18:15+08:00"
            }
        ],
        "RequestId": "e1b258f6-746d-4eb3-b7e0-ca400e7f8d71",
        "TotalCount": 8
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter Incorrect parameter.
ResourceNotFound The resource does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support