Skip to main content
Version: v22.10

新建分组

接口概述#

  • 功能:新建分组
  • 请求方式:POST
  • 请求地址:/api/contact/groups

请求参数#

参数名类型必须参数位置描述示例值
namestringbody分组名称我的分组
owner_user_idintegerbody分组所属帐号(个人用户ID或团队ID60002245150
owner_user_typeintegerbody分组所属帐号类型 1=团队,2=个人用户1

响应参数#

参数名类型描述
group_idinteger分组ID
owner_user_idinteger分组所属个人用户ID或团队ID
creator_user_idinteger分组ID
identitystring分组标识(相同owner_user_id下唯一)
internal_group_idinteger该分组存在于团队通讯录中的id(为0表示不存在于团队通讯录)
namestring分组名称
created_atstring创建时间
updated_atstring更新时间
parent_idinteger父级分组ID
orderinteger排序(数值越大越靠后)

响应示例#

  • 请求成功
{  "code": "OK",  "error": {    "type": ""  },  "data": {    "group": {      "id": 3259358,      "owner_user_id": 60002245150,      "creator_user_id": 50000012518,      "identity": "",      "internal_group_id": 0,      "name": "未命名分组",      "is_default": 0,      "created_at": "2022-10-16 20:13:52",      "updated_at": "2022-10-16 20:13:52",      "parent_id": 0,      "order": 0    }  },  "request_id": "7c61197c-5682-46b8-9a55-eea533ac2739"}
  • 请求失败
{    "code": "InvalidArgument",    "error": {        "type": "invalid_argument"    },    "data": {},    "request_id": "ddec96d2-165e-4f3e-8a64-2057db116983"}

错误码#

error.type 错误代码错误描述
invalid_argument参数校验不通过
claim_error无权限