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

dingtalk.oapi.serviceaccount.list (查询服务号列表)

查询服务号列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
pageStart	Number	可选	1	默认值：1 最小值：1	页码，第几页，从1开始算
pageSize	Number	可选	5	默认值：5 最小值：1 最大值：50	每页条数

响应参数

名称	类型	示例值	描述
errmsg	String	ok	错误信息
errcode	Number	0	错误码
total_count	Number	20	总记录数
item_count	Number	5	当前记录数
items	PublisherDTO []		服务号列表
└ desc String 我是钉三多机器人主页中的服务号功能简介 └ preview_media_id String @lALPBbCc1XuaP_rNAljNAlg 机器人主页中，消息预览图片的mediaId └ brief String 互动服务窗机器人管理列表中的简介 └ avatar_media_id String @lALPBbCc1XuaP_rNAljNAlg 头像图片mediaId └ name String 服务号001 服务号名称 └ status String normal 状态，normal-正常，disabled-停用 └ unionid String jYdrJoCmTo0iE 服务号的unionid

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/serviceaccount/list");
OapiServiceaccountListRequest req = new OapiServiceaccountListRequest();
req.setPageStart(1L);
req.setPageSize(5L);
OapiServiceaccountListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/serviceaccount/list");
OapiServiceaccountListRequest req = new OapiServiceaccountListRequest();
req.PageStart = 1L;
req.PageSize = 5L;
OapiServiceaccountListResponse 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 OapiServiceaccountListRequest;
$req->setPageStart("1");
$req->setPageSize("5");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/serviceaccount/list");

curl -X POST "https://oapi.dingtalk.com/topapi/serviceaccount/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e8249c63-a041-4952-b243-e7d97d08ce10' \
-d 'pageSize=5' \
-d 'pageStart=1'

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

req=dingtalk.api.OapiServiceaccountListRequest("https://oapi.dingtalk.com/topapi/serviceaccount/list")

req.pageStart=1
req.pageSize=5
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.serviceaccount.list");
add_param(pRequest,"pageStart","1");
add_param(pRequest,"pageSize","5");
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.serviceaccount.list', {
	'pageStart':'1',
	'pageSize':'5'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errmsg":"ok",
    "errcode":0,
    "total_count":20,
    "item_count":5,
    "items":[
        {
                "desc":"我是钉三多",
                "preview_media_id":"@lALPBbCc1XuaP_rNAljNAlg",
                "brief":"互动服务窗",
                "avatar_media_id":"@lALPBbCc1XuaP_rNAljNAlg",
                "name":"服务号001",
                "status":"normal",
                "unionid":"jYdrJoCmTo0iE"
        }
    ]
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.serviceaccount.list (查询服务号列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ