如何调用服务端API

调用钉钉服务端API前，需要先获取API调用凭证并申请接口权限。

准备工作

在正式开发前，你还需要完成以下准备工作。

已经完成了钉钉开发者的注册与激活并拥有了子管理员和开发者权限。若尚未完成，请参考成为钉钉开发者。

已创建应用并成为拥有应用的管理权限。若未完成，请参考应用类型介绍。

确保了解钉钉开放平台基础参数概念，详情请参考基础概念。

确保你已了解调用频率限制。详情请参考调用频率限制。

每个接口文档会按照如下格式提供信息：

请求方式：接口使用的HTTP方法和请求协议。所有接口都使用HTTPS协议。

请求地址：接口的请求地址。钉钉服务端接口的访问域名为https://oapi.dingtalk.com。请求参数使用“&”分隔。请求地址中的大写单词是需要替换的变量值。

请求****包体/参数说明：提供请求参数示例及说明，参数说明包括字段含义、取值范围，开发者在设计数据结构时，应参考该定义范围。

返回结果/参数说明：提供返回参数示例及说明。

注意

所有接口在调用失败时都会返回errcode和errmsg。开发者可根据errcode和errmsg排查问题。

请不要仅根据errmsg判断调用是否成功。当请求返回结果中返回了errcode且不为0时可判断为请求失败。errmsg是对errcode的说明，供开发者参考排查问题。

我们对接口的返回字段做了简化处理，如果字段的值为空或者null，将不返回该字段。

如下图所示，在调用钉钉服务端接口前，您需要完成以下准备工作：

创建一个钉钉应用，详情请参考应用类型介绍。

添加接口调用权限。应用创建后默认只开放登录和消息通知接口的调用权限，您需要根据开发需要，添加对应的接口使用权限。详细信息请参考添加接口调用权限。

获取应用的access_token。access_token相当于是身份凭证。调用接口时，通过access_token来鉴权调用者身份。

企业内部应用请参考获取access_token

第三方企业应用请参考获取第三方应用凭证
调用流程

钉钉开放平台提供了API Explorer和SDK方便开发者调用服务端API。

API Explorer：

API Explorer是可视化在线API调用工具，可实时查看API请求和返回结果。访问地址：https://open-dev.dingtalk.com/apiExplorer#/?devType=org&api=dingtalk.oapi.gettoken。

SDK:

钉钉开放平台提供了Java、PHP、Python、.NET SDK供开发者使用。单击服务端SDK下载。