新增服务号

POST

http://127.0.0.1/topapi/serviceaccount/add

服务端API/专属钉钉/互动服务窗/服务号管理

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口新增一个服务号。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

错误码

错误码	说明	排查方法
800001	请勿创建重复名称的服务号	修改服务号名称。
800004	可创建服务号数量达到上限	最多允许创建40个。

请求参数

Query 参数

access_token

string

必需

调用服务端接口的授权凭证。企业内部应用可通过调用access_token接口获得。

示例值:

30c9a84136943eaxxxx

Body 参数application/json

name

string

服务号名称。

必需

avatar_media_id

string

必需

头像图片mediaId，可以通过上传媒体文件接口上传图片获取mediaId。

brief

string

可选

机器人管理列表中的简介。

desc

string

必需

机器人主页中的服务号功能简介，最多200个字符。

preview_media_id

string

必需

机器人主页中，消息预览图片的mediaId，可以通过上传媒体文件接口上传图片获取mediaId。

示例

{
  "brief": "互动服务窗",
  "preview_media_id": "@lALPBbCc1XuaP_rNAljNAlg",
  "name": "创建服务号",
  "avatar_media_id": "@lALPBbCc1XuaP_rNAljNAlg",
  "desc": "我是描述"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/serviceaccount/add?access_token=30c9a84136943eaxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "brief": "互动服务窗",
    "preview_media_id": "@lALPBbCc1XuaP_rNAljNAlg",
    "name": "创建服务号",
    "avatar_media_id": "@lALPBbCc1XuaP_rNAljNAlg",
    "desc": "我是描述"
}'

返回响应

🟢200成功

application/json

Body

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

unionid

string

可选

服务号的unionid。

string

请求ID。

可选

示例

{
  "errmsg": "string",
  "errcode": 0,
  "unionid": "string",
  "": "string"
}

修改于 2022-08-30 09:19:24

获取企业DING使用数据（部门维度）

更新服务号

新增服务号

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码