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

dingtalk.oapi.smartdevice.visitor.editvisitor (编辑企业访客预约数据)

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。

请求参数

名称	类型	是否必须	示例值	描述
reservation_id	String	必须	123456	预约编号
visitor_vo	DidoVisitorVo	必须		预约数据
└ appointed_endtime Number 必须 1525764927000 预约开始时间 └ appointed_starttime Number 必须 1525764927000 预约结束时间 └ extra_info String 可选无扩展信息 └ media_id String 可选 @mediaId 可识别照片 └ mobile String 可选 13012345678 访客手机号 └ notify_user_list String [] 必须 ["1234","2345"] 通知用户ID └ recognize_endtime Number 可选 1525764927000 识别开始时间 └ recognize_starttime Number 可选 1525764927000 识别结束时间 └ user_name String 必须张三访客姓名 └ userid String 可选 12345 访客外部联系人ID └ user_type String 必须 interview, friends,business, communication,training, inspection ,other 来访目的

响应参数

名称	类型	示例值	描述
errcode	Number	fail	dingOpenErrcode
errmsg	String	FAIL	errorMsg
result	Boolean	true	result

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/visitor/editvisitor");
OapiSmartdeviceVisitorEditvisitorRequest req = new OapiSmartdeviceVisitorEditvisitorRequest();
req.setReservationId("123456");
DidoVisitorVo obj1 = new DidoVisitorVo();
obj1.setAppointedEndtime(1525764927000L);
obj1.setAppointedStarttime(1525764927000L);
obj1.setExtraInfo("无");
obj1.setMediaId("@mediaId");
obj1.setMobile("13012345678");
obj1.setNotifyUserList(""1234","2345"");
obj1.setRecognizeEndtime(1525764927000L);
obj1.setRecognizeStarttime(1525764927000L);
obj1.setUserName("张三");
obj1.setUserid("12345");
obj1.setUserType("interview,  friends,business, communication,training, inspection ,other");
req.setVisitorVo(obj1);
OapiSmartdeviceVisitorEditvisitorResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/visitor/editvisitor");
OapiSmartdeviceVisitorEditvisitorRequest req = new OapiSmartdeviceVisitorEditvisitorRequest();
req.ReservationId = "123456";
OapiSmartdeviceVisitorEditvisitorRequest.DidoVisitorVoDomain obj1 = new OapiSmartdeviceVisitorEditvisitorRequest.DidoVisitorVoDomain();
obj1.AppointedEndtime = 1525764927000L;
obj1.AppointedStarttime = 1525764927000L;
obj1.ExtraInfo = "无";
obj1.MediaId = "@mediaId";
obj1.Mobile = "13012345678";
obj1.NotifyUserList = ""1234","2345"";
obj1.RecognizeEndtime = 1525764927000L;
obj1.RecognizeStarttime = 1525764927000L;
obj1.UserName = "张三";
obj1.Userid = "12345";
obj1.UserType = "interview,  friends,business, communication,training, inspection ,other";
req.VisitorVo_ = obj1;
OapiSmartdeviceVisitorEditvisitorResponse 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 OapiSmartdeviceVisitorEditvisitorRequest;
$req->setReservationId("123456");
$visitor_vo = new DidoVisitorVo;
$visitor_vo->appointed_endtime="1525764927000";
$visitor_vo->appointed_starttime="1525764927000";
$visitor_vo->extra_info="无";
$visitor_vo->media_id="@mediaId";
$visitor_vo->mobile="13012345678";
$visitor_vo->notify_user_list="[\"1234\",\"2345\"]";
$visitor_vo->recognize_endtime="1525764927000";
$visitor_vo->recognize_starttime="1525764927000";
$visitor_vo->user_name="张三";
$visitor_vo->userid="12345";
$visitor_vo->user_type="interview,  friends,business, communication,training, inspection ,other";
$req->setVisitorVo($visitor_vo);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartdevice/visitor/editvisitor");

curl -X POST "https://oapi.dingtalk.com/topapi/smartdevice/visitor/editvisitor" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=fd299010-4414-4c40-8ff8-0bfe94df86cd' \
-d 'reservation_id=123456' \
-d 'visitor_vo=null'

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

req=dingtalk.api.OapiSmartdeviceVisitorEditvisitorRequest("https://oapi.dingtalk.com/topapi/smartdevice/visitor/editvisitor")

req.reservation_id="123456"
req.visitor_vo=""
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.smartdevice.visitor.editvisitor");
add_param(pRequest,"reservation_id","123456");
add_param(pRequest,"visitor_vo","数据结构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.smartdevice.visitor.editvisitor', {
	'reservation_id':'123456',
	'visitor_vo':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":fail,
    "errmsg":"FAIL",
    "result":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartdevice.visitor.editvisitor (编辑企业访客预约数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ