文档中心 > API类目 > 钉钉API

dingtalk.oapi.org.openencrypt.heartbeat (企业内部微应用心跳)

ISV调用该心跳接口，表明自己存活状态

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
top_kms_heartbeat	TopKMSHeartbeat	必须			请求参数
└ requestid String 必须 uehuf8r839r3jeifef 请求id └ payload String 可选 {} 附加数据，json格式 └ agentid Number 必须 78672 企业内部应用id

响应参数

名称	类型	示例值	描述
result	String	""	一般是空字符串
errmsg	String	成功	成功
errcode	Number	0	0
success	Boolean	true	true

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/org/openencrypt/heartbeat");
OapiOrgOpenencryptHeartbeatRequest req = new OapiOrgOpenencryptHeartbeatRequest();
TopKMSHeartbeat obj1 = new TopKMSHeartbeat();
obj1.setRequestid("uehuf8r839r3jeifef");
obj1.setPayload("{}");
obj1.setAgentid(78672L);
req.setTopKmsHeartbeat(obj1);
OapiOrgOpenencryptHeartbeatResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/org/openencrypt/heartbeat");
OapiOrgOpenencryptHeartbeatRequest req = new OapiOrgOpenencryptHeartbeatRequest();
OapiOrgOpenencryptHeartbeatRequest.TopKMSHeartbeatDomain obj1 = new OapiOrgOpenencryptHeartbeatRequest.TopKMSHeartbeatDomain();
obj1.Requestid = "uehuf8r839r3jeifef";
obj1.Payload = "{}";
obj1.Agentid = 78672L;
req.TopKmsHeartbeat_ = obj1;
OapiOrgOpenencryptHeartbeatResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiOrgOpenencryptHeartbeatRequest;
$top_kms_heartbeat = new TopKMSHeartbeat;
$top_kms_heartbeat->requestid="uehuf8r839r3jeifef";
$top_kms_heartbeat->payload="{}";
$top_kms_heartbeat->agentid="78672";
$req->setTopKmsHeartbeat($top_kms_heartbeat);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/org/openencrypt/heartbeat");

curl -X POST "https://oapi.dingtalk.com/topapi/org/openencrypt/heartbeat" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=34cdcf03-e303-4830-b696-9e77789120d5' \
-d 'top_kms_heartbeat=null'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiOrgOpenencryptHeartbeatRequest("https://oapi.dingtalk.com/topapi/org/openencrypt/heartbeat")

req.top_kms_heartbeat=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.org.openencrypt.heartbeat");
add_param(pRequest,"top_kms_heartbeat","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.org.openencrypt.heartbeat', {
	'top_kms_heartbeat':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":"\"\"",
    "errmsg":"成功",
    "errcode":0,
    "success":true
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.org.openencrypt.heartbeat (企业内部微应用心跳)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ