You can call this operation to query DingTalk notifications.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDingTalk

The operation that you want to perform.

Set the value to DescribeDingTalk.

RuleActionName String No Vulnerability notifications

The name of the notification.

PageSize Integer Optional 20

The number of entries to return on each page.

CurrentPage Integer No 1

The page number of the returned page.

Response parameters

Parameter Type Example Description
RequestId String B256A525-7E42-4BB9-A27C-9017FDDFF1A2

The ID of the request.

ActionList Array

The list of notifications.

GmtModified Long 1550828400000

The time when the notification was modified.

Id Integer 1

The ID of the notification.

AliUid Long 12312412341

The UID of the user.

GmtCreate Long 1550828400000

The time when the notification was created.

Url String https://oapi.dingtalk.com/robot/send

The parameters of the notification.

IntervalTime Integer 1000

The notification interval.

ActionName String Alerts

The name of the notification.

Status Integer 1

The status of the notification. Valid values:

  • 0: Notifications are disabled.
  • 1: Notifications are enabled.
ConfigList String [{\"type\":\"vul\",\"configItemList\":[{\"key\":\"key\", \"valueList\":\"123\"}]}]

The list of notification settings.

GroupIdList String "123,456"

The list of group IDs.

DingTalkLang String zh

The language of notifications. Valid values:

  • zh: Chinese
  • en: English
PageInfo Struct

The pagination information.

PageSize Integer 20

The number of entries returned per page.

TotalCount Integer 1

The total number of notifications.

CurrentPage Integer 1

The page number of the returned page.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDingTalk
&<Common request parameters>

Sample success responses

XML format

<DescribeDingTalkResponse>
    <PageInfo>
        <PageSize>20</PageSize>
        <CurrentPage>1</CurrentPage>
        <TotalCount>1</TotalCount>
    </PageInfo>
    <ActionList>
        <ActionName>Alerts</ActionName>
        <GmtCreate>1550828400000</GmtCreate>
        <GmtModified>1550828400000</GmtModified>
        <IntervalTime>1000</IntervalTime>
        <Id>1</Id>
        <Url>https://oapi.dingtalk.com/robot/send</Url>
        <AliUid>12312412341</AliUid>
        <configList>[{"type":"vul","configItemList":[{"key":"key", "valueList":"123"}]}]</configList>
        <groupIdList>123,456</groupIdList>
    </ActionList>
    <requestId>B256A525-7E42-4BB9-A27C-9017FDDFF1A2</requestId>
</DescribeDingTalkResponse>

JSON format

{
    "PageInfo": {
      "PageSize": 20,
      "CurrentPage": 1,
      "TotalCount":1
    },
    "ActionList": [{
      "ActionName": "Alerts",
      "GmtCreate": "1550828400000",
      "GmtModified": "1550828400000",
      "IntervalTime": 1000,
      "Id": 1,
      "Url": "https://oapi.dingtalk.com/robot/send",
      "AliUid": 12312412341,
      "configList":"[{\"type\":\"vul\",\"configItemList\":[{\"key\":\"key\", \"valueList\":\"123\"}]}]",
      "groupIdList":"123,456"
    }],
  "requestId": "B256A525-7E42-4BB9-A27C-9017FDDFF1A2"
}

Error codes

For a list of error codes, visit the API Error Center.