dingtalk.oapi.serviceaccount.get (查询服务号详情)

查询服务号详情

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
unionid String 必须 jYdrJoCmTo0iE 服务号的unionid

响应参数

名称 类型 示例值 描述
errmsg String ok 错误信息
errcode Number 0 错误码
service_account ServiceAccountDTO 服务号详情
  • └ status
  • String
  • normal
  • 状态,normal-正常,disabled-删除
  • └ unionid
  • String
  • jYdrJoCmTo0iE
  • 服务号的unionid
  • └ name
  • String
  • 服务号001
  • 服务号名称
  • └ brief
  • String
  • 互动服务窗
  • 机器人管理列表中的简介,最多60个字符
  • └ desc
  • String
  • 我是钉三多
  • 机器人主页中的服务号功能简介,最多200个字符
  • └ avatar_media_id
  • String
  • @lALPBbCc1XuaP_rNAljNAlg
  • 头像图片mediaId
  • └ preview_media_id
  • String
  • @lALPBbCc1XuaP_rNAljNAlg
  • 机器人主页中,消息预览图片的mediaId
  • └ chat_bot_id
  • String
  • follow01
  • 机器人id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/serviceaccount/get");
OapiServiceaccountGetRequest req = new OapiServiceaccountGetRequest();
req.setUnionid("jYdrJoCmTo0iE");
OapiServiceaccountGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "errmsg":"ok",
    "errcode":0,
    "service_account":{
        "status":"normal",
        "unionid":"jYdrJoCmTo0iE",
        "name":"服务号001",
        "brief":"互动服务窗",
        "desc":"我是钉三多",
        "avatar_media_id":"@lALPBbCc1XuaP_rNAljNAlg",
        "preview_media_id":"@lALPBbCc1XuaP_rNAljNAlg",
        "chat_bot_id":"follow01"
    }
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部