添加家长

POST

http://127.0.0.1/topapi/edu/guardian/create

服务端API/新教育/家校通讯录2.0/通讯录信息写入

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

责任人：未设置

说明

调用本接口在指定的班级下添加家长信息。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考调用说明（家校通讯录2.0）。

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

请求参数

Query 参数

access_token

string

必需

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

示例值:

6d1bxxxx

Body 参数application/json

class_id

number

班级ID。

必需

stu_id

string

学生ID。

必需

mobile

string

手机号码。

必需

biz_id

string

业务ID。

可选

operator

string

钉钉企业管理员。

必需

relation

string

必需

家长与学生的关系：F：爸爸M：妈妈GF：爷爷GM：奶奶GFA：外公GMA：外婆U：叔叔A：阿姨B：哥哥S：姐姐O：其他

示例

{
  "class_id": 4240018,
  "stu_id": "2334455",
  "mobile": "150xxxx2322",
  "operator": "user01",
  "relation": "F"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/edu/guardian/create?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "class_id": 4240018,
    "stu_id": "2334455",
    "mobile": "150xxxx2322",
    "operator": "user01",
    "relation": "F"
}'

返回响应

🟢200成功

application/json

Body

result

object

调用结果。

可选

biz_id

string

业务ID。

可选

userid

string

可选

家长的userid。

success

boolean

请求是否成功。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
  "result": {
    "biz_id": "string",
    "userid": "string"
  },
  "success": true,
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string"
}

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

添加老师

学生调班

添加家长

说明#

权限#

请求参数

示例代码

返回响应

说明

权限