POST sns/v3/Sns/AddGroup?admMids={admMids}&scene={scene}

添加群组

Request

URI Params

字段名字段说明字段类型附加信息
admMids

群组管理员MID集合

 string

Required
scene

添加群组场景 如：创建班级、创建教研组等

 CreateGroupScene

Default value is Class

Body Params

群组

GroupApiModel
字段名字段说明字段类型附加信息
GID

群组ID

 integer

None.
CardNo

群组号

 string

None.
CTypeName

群组自定义类型

 string

None.
CTypeSNO

群组自定义类型

 integer

None.
GTypeID

群组类型

 integer

None.
GTypeName

群组类型名

 string

None.
GTypeSNO

群组类型排序

 integer

None.
Level

群组Level

 integer

None.
PGID

父群组

 integer

None.
PGName

父群组名称

 string

None.
RID

群组所属区域ID

 integer

None.
RName

群组所属区域

 string

None.
Pic

群组头像

 string

None.
Name

群组简称

 string

None.
PY

拼音

 string

None.
FName

全称

 string

None.
Desc

描述

 string

None.
SNO

排序

 integer

None.
JMode

加入群组方式

 JoinGroupMode

None.
JoinBySelf

自主加入

 boolean

None.
InCode

验证码

 string

None.
InGroup

是否存在于群组

 boolean

None.
Requested

是否已经请求加入了

 boolean

None.
AdmCnt

管理员数量

 integer

None.
MemberCnt

成员数量

 integer

None.
UnRelateCnt

未开通数量

 integer

None.
AllowSendInfo

是否允许发送信息

 boolean

None.
ShowContact

是否显示在通讯录

 boolean

None.
Recommend

搜索社会化群组时推荐

 boolean

None.
IsCust

优信定制版

 boolean

None.
IsCode

是否启用激活码

 boolean

None.
AllowCreateGroup

是否允许创建子群组

 boolean

None.
Props

扩展属性集合

 Collection of PropertyApiModel

None.
Phase

教育阶段 对于学校可能有多个 对于班级仅仅一个

 string

None.
Grade

级届

 integer

None.
ClassNO

班号

 integer

None.
HasSD

是否包含会话文件夹

 boolean

None.
SendStudentInfo

是否允许发送信息给学生

 boolean

None.
Date

创建时间

 date

None.
ShowHead

是否在会话文件夹内显示群组头部

 boolean

None.
InAmount

加入金额

 decimal number

None.

Request Formats

application/json, text/json

Sample: 
{
  "GID": "1",
  "CardNo": "sample string 2",
  "CTypeName": "sample string 3",
  "CTypeSNO": 4,
  "GTypeID": 5,
  "GTypeName": "sample string 6",
  "GTypeSNO": 7,
  "Level": 8,
  "PGID": 9,
  "PGName": "sample string 10",
  "RID": 11,
  "RName": "sample string 12",
  "Pic": "sample string 13",
  "Name": "sample string 14",
  "PY": "sample string 15",
  "FName": "sample string 16",
  "Desc": "sample string 17",
  "SNO": 18,
  "JMode": 0,
  "JoinBySelf": true,
  "InCode": "sample string 20",
  "InGroup": true,
  "Requested": true,
  "AdmCnt": 23,
  "MemberCnt": 24,
  "UnRelateCnt": 25,
  "AllowSendInfo": true,
  "ShowContact": true,
  "Recommend": true,
  "IsCust": true,
  "IsCode": true,
  "AllowCreateGroup": true,
  "Props": [
    {
      "Name": "sample string 1",
      "Desc": "sample string 2",
      "Val": "sample string 3",
      "SNO": 4
    },
    {
      "Name": "sample string 1",
      "Desc": "sample string 2",
      "Val": "sample string 3",
      "SNO": 4
    }
  ],
  "Phase": "sample string 32",
  "Grade": 33,
  "ClassNO": 34,
  "HasSD": true,
  "SendStudentInfo": true,
  "Date": "2025-05-22T12:40:21.299Z",
  "ShowHead": true,
  "InAmount": 39.1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response

APITResultOfGroupMembersApiModel
字段名字段说明字段类型附加信息
Data

GroupMembersApiModel

None.
Ret

返回结果（0-成功；>0-失败） ret=0 成功返回/ret=1 参数错误/ret=2 频率受限 /ret=3 Token无效 /ret=4 服务器内部错误 /ret=5 用户操作错误 / ret=6 停机维护 / ret=7 身份失效

 integer

None.
ErrCode

错误代码，因功能而异

 integer

None.
Msg

返回信息

 string

None.
SeqId

请求序列

 integer

None.
InfoMsg

API附加信息

 string

None.

application/json, text/json

Sample: 
{
  "Data": {
    "GroupSD": {
      "SD": {
        "SDID": 1,
        "SDType": 1,
        "BID": 2,
        "TipLevel": 0,
        "Config": "sample string 3",
        "Title": "sample string 4",
        "Tips": "sample string 5",
        "TipsColor": "sample string 6",
        "Pic": "sample string 7",
        "TitleColor": "sample string 8",
        "BgColor": "sample string 9",
        "CmdType": 0,
        "Url": "sample string 10",
        "CusDesc": "sample string 11",
        "CusDate": "2025-05-22T12:40:21.309Z"
      },
      "Group": {
        "GID": "1",
        "CardNo": "sample string 2",
        "CTypeName": "sample string 3",
        "CTypeSNO": 4,
        "GTypeID": 5,
        "GTypeName": "sample string 6",
        "GTypeSNO": 7,
        "Level": 8,
        "PGID": 9,
        "PGName": "sample string 10",
        "RID": 11,
        "RName": "sample string 12",
        "Pic": "sample string 13",
        "Name": "sample string 14",
        "PY": "sample string 15",
        "FName": "sample string 16",
        "Desc": "sample string 17",
        "SNO": 18,
        "JMode": 0,
        "JoinBySelf": true,
        "InCode": "sample string 20",
        "InGroup": true,
        "Requested": true,
        "AdmCnt": 23,
        "MemberCnt": 24,
        "UnRelateCnt": 25,
        "AllowSendInfo": true,
        "ShowContact": true,
        "Recommend": true,
        "IsCust": true,
        "IsCode": true,
        "AllowCreateGroup": true,
        "Props": [
          {
            "Name": "sample string 1",
            "Desc": "sample string 2",
            "Val": "sample string 3",
            "SNO": 4
          },
          {
            "Name": "sample string 1",
            "Desc": "sample string 2",
            "Val": "sample string 3",
            "SNO": 4
          }
        ],
        "Phase": "sample string 32",
        "Grade": 33,
        "ClassNO": 34,
        "HasSD": true,
        "SendStudentInfo": true,
        "Date": "2025-05-22T12:40:21.309Z",
        "ShowHead": true,
        "InAmount": 39.1
      }
    },
    "Members": {
      "ViewModelList": [
        {
          "GID": 1,
          "MID": 2,
          "MTypeID": 3,
          "MTypeName": "sample string 4",
          "Name": "sample string 5",
          "Title": "sample string 6",
          "GTitle": "sample string 7",
          "PTel": "sample string 8",
          "PTitle": "sample string 9",
          "ChildMID": 10,
          "UID": 11,
          "UCode": "sample string 12",
          "UName": "sample string 13",
          "Tel": "sample string 14",
          "Pic": "sample string 15",
          "PY": "sample string 16",
          "AppST": 1,
          "AdmLevel": 0,
          "Banned": true,
          "AllowSendInfo": true,
          "MParent": false,
          "Props": [
            {
              "Name": "sample string 1",
              "Desc": "sample string 2",
              "Val": "sample string 3",
              "SNO": 4
            },
            {
              "Name": "sample string 1",
              "Desc": "sample string 2",
              "Val": "sample string 3",
              "SNO": 4
            }
          ],
          "TelDisplay": 0
        },
        {
          "GID": 1,
          "MID": 2,
          "MTypeID": 3,
          "MTypeName": "sample string 4",
          "Name": "sample string 5",
          "Title": "sample string 6",
          "GTitle": "sample string 7",
          "PTel": "sample string 8",
          "PTitle": "sample string 9",
          "ChildMID": 10,
          "UID": 11,
          "UCode": "sample string 12",
          "UName": "sample string 13",
          "Tel": "sample string 14",
          "Pic": "sample string 15",
          "PY": "sample string 16",
          "AppST": 1,
          "AdmLevel": 0,
          "Banned": true,
          "AllowSendInfo": true,
          "MParent": false,
          "Props": [
            {
              "Name": "sample string 1",
              "Desc": "sample string 2",
              "Val": "sample string 3",
              "SNO": 4
            },
            {
              "Name": "sample string 1",
              "Desc": "sample string 2",
              "Val": "sample string 3",
              "SNO": 4
            }
          ],
          "TelDisplay": 0
        }
      ],
      "PageSize": 1,
      "TotalRecords": 2,
      "PageIndex": 3,
      "Pages": 4
    }
  },
  "Ret": 1,
  "ErrCode": 2,
  "Msg": "sample string 3",
  "SeqId": 4,
  "InfoMsg": "sample string 5"
}