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

dingtalk.oapi.im.chatbot.delete (删除会话内机器人实例)

根据开放的conversationId和机器人示例userId，删除会话内机器人实例

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
open_conversation_id	String	必须	cidxxxx	最大长度：128	开放的会话conversationId
chatbot_user_id	String	必须	dingxxx	最大长度：128	开放的机器人userId

响应参数

名称	类型	示例值	描述
result	String	dingxxx	删除成功的机器人userId
errmsg	String	成功	错误描述
errcode	Number	0	错误代码

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chatbot/delete");
OapiImChatbotDeleteRequest req = new OapiImChatbotDeleteRequest();
req.setOpenConversationId("cidxxxx");
req.setChatbotUserId("dingxxx");
OapiImChatbotDeleteResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chatbot/delete");
OapiImChatbotDeleteRequest req = new OapiImChatbotDeleteRequest();
req.OpenConversationId = "cidxxxx";
req.ChatbotUserId = "dingxxx";
OapiImChatbotDeleteResponse 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 OapiImChatbotDeleteRequest;
$req->setOpenConversationId("cidxxxx");
$req->setChatbotUserId("dingxxx");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/im/chatbot/delete");

curl -X POST "https://oapi.dingtalk.com/topapi/im/chatbot/delete" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=df04e6cb-9ba4-4db0-9355-b4b5fbf7903f' \
-d 'chatbot_user_id=dingxxx' \
-d 'open_conversation_id=cidxxxx'

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

req=dingtalk.api.OapiImChatbotDeleteRequest("https://oapi.dingtalk.com/topapi/im/chatbot/delete")

req.open_conversation_id="cidxxxx"
req.chatbot_user_id="dingxxx"
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.im.chatbot.delete");
add_param(pRequest,"open_conversation_id","cidxxxx");
add_param(pRequest,"chatbot_user_id","dingxxx");
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.im.chatbot.delete', {
	'open_conversation_id':'cidxxxx',
	'chatbot_user_id':'dingxxx'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":"dingxxx",
    "errmsg":"成功",
    "errcode":0
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.im.chatbot.delete (删除会话内机器人实例)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ