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

dingtalk.oapi.smartdevice.visitor.sendnotify (为访客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。

请求参数

名称	类型	是否必须	示例值	描述
visitor_notify_vo	VisitorNotifyVo	可选		访客通知模型
└ content String 必须你的访客已到前台，请前往接待消息内容 └ device_id Number 必须 1234 设备ID └ notify_type Number 必须 1 通知类型 └ user_name String 必须张三访客姓名 └ userid String 可选 san_id 外部联系ID └ feedback String 可选 agree 接待意见反馈
reservation_id	String	可选	3258	预约ID

响应参数

名称	类型	示例值	描述
errcode	Number	0	dingOpenErrcode
errmsg	String	成功	errorMsg
result	Boolean	true	result
success	Boolean	true	success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/visitor/sendnotify");
OapiSmartdeviceVisitorSendnotifyRequest req = new OapiSmartdeviceVisitorSendnotifyRequest();
VisitorNotifyVo obj1 = new VisitorNotifyVo();
obj1.setContent("你的访客已到前台，请前往接待");
obj1.setDeviceId(1234L);
obj1.setNotifyType(1L);
obj1.setUserName("张三");
obj1.setUserid("san_id");
obj1.setFeedback("agree");
req.setVisitorNotifyVo(obj1);
req.setReservationId("3258");
OapiSmartdeviceVisitorSendnotifyResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartdevice/visitor/sendnotify");
OapiSmartdeviceVisitorSendnotifyRequest req = new OapiSmartdeviceVisitorSendnotifyRequest();
OapiSmartdeviceVisitorSendnotifyRequest.VisitorNotifyVoDomain obj1 = new OapiSmartdeviceVisitorSendnotifyRequest.VisitorNotifyVoDomain();
obj1.Content = "你的访客已到前台，请前往接待";
obj1.DeviceId = 1234L;
obj1.NotifyType = 1L;
obj1.UserName = "张三";
obj1.Userid = "san_id";
obj1.Feedback = "agree";
req.VisitorNotifyVo_ = obj1;
req.ReservationId = "3258";
OapiSmartdeviceVisitorSendnotifyResponse 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 OapiSmartdeviceVisitorSendnotifyRequest;
$visitor_notify_vo = new VisitorNotifyVo;
$visitor_notify_vo->content="你的访客已到前台，请前往接待";
$visitor_notify_vo->device_id="1234";
$visitor_notify_vo->notify_type="1";
$visitor_notify_vo->user_name="张三";
$visitor_notify_vo->userid="san_id";
$visitor_notify_vo->feedback="agree";
$req->setVisitorNotifyVo($visitor_notify_vo);
$req->setReservationId("3258");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartdevice/visitor/sendnotify");

curl -X POST "https://oapi.dingtalk.com/topapi/smartdevice/visitor/sendnotify" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ca72568f-2efb-4012-aabe-dd38b085a5c7' \
-d 'reservation_id=3258' \
-d 'visitor_notify_vo=null'

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

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

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

响应示例

JSON示例

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

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartdevice.visitor.sendnotify (为访客ISV提供发送通知的功能)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ