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

dingtalk.oapi.project.invite.shareurl.get (开放式组织机构专属分享二维码链接)

开放式组织机构专属分享二维码链接

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
invite_info	InviteUrlQuery	必须			邀请信息
└ expire_seconds Number 可选 2592000 默认值：900 该分享链接有效时间，以秒为单位。最大不超过7776000（即90天），此字段如果不填，则默认有效期为30秒。 └ userid String 必须 ag55zv2efexsgywixwuea4wggq 邀请人的员工ID └ scene_id String 必须 ActivityMayDay 场景标志，用于区分活动场景 └ redirect String 可选 URL_sgywixw 活动生效后的承接页面标志 └ term_type String 可选 SHORT 默认值：SHORT 期限类型：SHORT短期（默认），LONG长期（最多10万个数量限制） └ chat_id String 可选 qe71248thisdhf87gw3rhg 圈子里关联的某个群ID

响应参数

名称	类型	示例值	描述
result	Result		响应结果
└ h5_url_group String https://www.dingtalk.com/group/share/FV03b2d6f7-8ca9-4898-9270-d13c1564368f 群专属链接 └ h5_url_circle String https://www.dingtalk.com/circle/share/FV998dae30-871c-4cc7-a84f-41a3cb646117 圈子专属链接 └ expire_seconds Number 180000 该二维码有效时间，以秒为单位。最大不超过2592000（即30天）。
success	Boolean	true	是否成功
errcode	Number	0	错误码
errmsg	String	demo	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/project/invite/shareurl/get");
OapiProjectInviteShareurlGetRequest req = new OapiProjectInviteShareurlGetRequest();
InviteUrlQuery obj1 = new InviteUrlQuery();
obj1.setExpireSeconds(2592000L);
obj1.setUserid("ag55zv2efexsgywixwuea4wggq");
obj1.setSceneId("ActivityMayDay");
obj1.setRedirect("URL_sgywixw");
obj1.setTermType("SHORT");
obj1.setChatId("qe71248thisdhf87gw3rhg");
req.setInviteInfo(obj1);
OapiProjectInviteShareurlGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/project/invite/shareurl/get");
OapiProjectInviteShareurlGetRequest req = new OapiProjectInviteShareurlGetRequest();
OapiProjectInviteShareurlGetRequest.InviteUrlQueryDomain obj1 = new OapiProjectInviteShareurlGetRequest.InviteUrlQueryDomain();
obj1.ExpireSeconds = 2592000L;
obj1.Userid = "ag55zv2efexsgywixwuea4wggq";
obj1.SceneId = "ActivityMayDay";
obj1.Redirect = "URL_sgywixw";
obj1.TermType = "SHORT";
obj1.ChatId = "qe71248thisdhf87gw3rhg";
req.InviteInfo_ = obj1;
OapiProjectInviteShareurlGetResponse 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 OapiProjectInviteShareurlGetRequest;
$invite_info = new InviteUrlQuery;
$invite_info->expire_seconds="2592000";
$invite_info->userid="ag55zv2efexsgywixwuea4wggq";
$invite_info->scene_id="ActivityMayDay";
$invite_info->redirect="URL_sgywixw";
$invite_info->term_type="SHORT";
$invite_info->chat_id="qe71248thisdhf87gw3rhg";
$req->setInviteInfo($invite_info);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/project/invite/shareurl/get");

curl -X POST "https://oapi.dingtalk.com/topapi/project/invite/shareurl/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ca7a23b5-df2f-488a-9a01-f1f7fff3c483' \
-d 'invite_info=null'

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

req=dingtalk.api.OapiProjectInviteShareurlGetRequest("https://oapi.dingtalk.com/topapi/project/invite/shareurl/get")

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

响应示例

JSON示例

{
    "result":{
        "h5_url_group":"https:\/\/www.dingtalk.com\/group\/share\/FV03b2d6f7-8ca9-4898-9270-d13c1564368f",
        "h5_url_circle":"https:\/\/www.dingtalk.com\/circle\/share\/FV998dae30-871c-4cc7-a84f-41a3cb646117",
        "expire_seconds":180000
    },
    "success":true,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.project.invite.shareurl.get (开放式组织机构专属分享二维码链接)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ