dingtalk.oapi.callback.failrecord.list (查询回调失败记录)

提供给isv用于查询http回调失败记录,做补偿

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
req Req 必须 请求参数
  • └ tags
  • String []
  • 必须
  • user_add_org
  • 回调事件类型
  • └ cursor
  • Number
  • 可选
  • 123
  • 分页查询,上次查询结果中的最后一个id
  • └ status
  • Number
  • 可选
  • 1
  • 确认状态,0-已确认 1-未确认,不填表示不区分
  • └ page_size
  • Number
  • 可选
  • 100
  • 默认值:100
  • 分页大小,最大支持100
  • └ begin_time
  • Number
  • 可选
  • 1553004084
  • 开始时间(单位:秒)。空表示不限,左闭右开。PS:当前只保留了7天的记录
  • └ end_time
  • Number
  • 可选
  • 1553014084
  • 结束时间(单位:秒)。空表示不限,左闭右开
  • └ confirm
  • Boolean
  • 可选
  • false
  • 默认值:false
  • 此次查询成功后,是否立即将状态改为“已确认”。传空取默认值false

响应参数

名称 类型 示例值 描述
failed_list FailedList [] 回调失败数据列表
  • └ call_back_data
  • String
  • 回调数据。不同事件类型不同,通常为JSON String
  • └ call_back_tag
  • String
  • user_add_org
  • 事件类型
  • └ event_time
  • Number
  • 1553004084000
  • 失败时间。单位:毫秒
  • └ corpid
  • String
  • ding123456
  • 企业id
  • └ id
  • Number
  • 123
  • 回调失败记录id
errmsg String ok 错误描述
errcode Number 0 错误码
has_more Boolean false 是否更多

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/callback/failrecord/list");
OapiCallbackFailrecordListRequest req = new OapiCallbackFailrecordListRequest();
Req obj1 = new Req();
obj1.setTags("user_add_org");
obj1.setCursor(123L);
obj1.setStatus(1L);
obj1.setPageSize(100L);
obj1.setBeginTime(1553004084L);
obj1.setEndTime(1553014084L);
obj1.setConfirm(false);
req.setReq(obj1);
OapiCallbackFailrecordListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "failed_list":[
        {
                "call_back_data":"",
                "call_back_tag":"user_add_org",
                "event_time":1553004084000,
                "corpid":"ding123456",
                "id":123
        }
    ],
    "errmsg":"ok",
    "errcode":0,
    "has_more":false
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部