Instant Messaging
Android
Getting Started
Introduction
Overview
Benefits
Features
Features
Account Integration and Login
Group Chat
Chat Room
Chat Room Tags
Multi-device Login
Statistics Monitoring
Limits
Integration
Interface Overview
Integrate and Initialize SDK
Messaging
Basic Messaging
Message History
Message Sending
Message Receiving
Recent Chats
Server Sessions
User Profile
User Relationship
Online Status Subscription
Push and Message Alert
Superteam
Chat Room
Moderation
Chat Extension
Miscellaneous Features
Best Practice
Traffic Control in Chat Rooms
Reference
API Reference
Status Codes

Team Features(Advanced team)

Update time: 2022/11/25 16:17:01

Note: 416 error code will be returned if all team operations by an IP address are completed for more than 6,000 times within a minute.

Create a team

Request URL

POST https://api-sg.netease.im/nimserver/team/create.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

  1. Create an advanced team and send messages to the users by invitation;
  2. The user-defined field is an extension field for third-parties. The third party can extend the features of the advanced team and create a team as desired;
  3. If a team is created, tid will be returned and saved for subsequent operations such as adding people and kicking people out of a team;
  4. There is a limit over the number of teams created by each user. The limit is determined by the team configuration under the IM package, and can be viewed by logging into the management background.

Parameters

ParameterTypeRequiredDescription
tnameStringYesTeam name, with a maximum length of 64 characters
ownerStringYesAccId of Team owner user, with a maximum length of 32 characters,
membersStringYesList of invited team members. \ ["aaa","bbb"\] (accid corresponding to JSONArray, parsing error results in code 414), The total sum of members and owner should not exceed 200. There is no need to add the owner' account into members'.
announcementStringNoTeam announcement, with a maximum length of 1024 characters
introStringNoTeam description, with a maximum length of 512 characters
msgStringYesText of the invitation sent, with a maximum length of 150 characters
magreeintYesWhen administrator creates a team on the background, 0 indicates invitees can be added to the team without their consent, and 1 indicates invitees' consent is required for adding them to the team. Otherwise 414 is returned
joinmodeintYesWhen operating the sdk after creating the team, 0 indicates verification is not required, 1 indicates verification is required, and 2 indicates no one is allowed to join the team. For other values, return 414
customStringNoCustomizable extension attributes of an advanced team, and third parties can customize and extend their own teams' attributes based on this attribute. (json is recommended), with a maximum length of 1024 characters
iconStringNoTeam profile picture, with a maximum length of 1024 characters
beinvitemodeintNoWhether the invitee's consent is required, 0-consent required (default), 1- consent not required. For other values, return 414
invitemodeintNoWho can invite others to join the team, 0-administrator (default), 1-everyone. For other values, return 414
uptinfomodeintNoWho can update team profile, 0-administrator (default), 1-everyone. For other values, return 414
upcustommodeintNoWho can update custom team attributes, 0-administrator (default), 1-everyone. For other values, return 414
teamMemberLimitintNoThe maximum number of people in the team (including the owner), range: from 2 to the maximum number defined by the application (default: 200). For other values, return 414
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tname=myteam&owner=zhangsan&members=["aaa","bbb"]&msg=welcome&magree=0&joinmode=0' 'https://api-sg.netease.im/nimserver/team/create.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "tid":"11001",
  "faccid":{
         "accid":["a","b","c"],
         "msg":"team count exceed"
     }
}

If the number of invited people exceeds the upper limit during creation, the faccid is returned.

Valid status codes

200, 403, 414, 416, 431, 500, 801, 806

See Status codes .


Invite a user to an advaned team

Request URL

POST https://api-sg.netease.im/nimserver/team/add.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

  1. You can invite multiple users at a time. The team owner must be specified for invitation;
    2. When the number of team members reaches the limit, failure will be returned for another invitation;
    3. When the number of team members reaches the limit, the invitee's operation "accept invitation" will fail.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned when the team is created, with a maximum length of 128 characters
ownerStringYesUser account, with a maximum length of 32 characters, passed in based on team attribute invitemode
membersStringYes["aaa","bbb"\] (accid corresponding to JSONArray, parsing error results in code 414), each time a maximum of 200 members can be added.
magreeintYesWhen administrator creates a team on the background, 0 indicates invitees can be added to the team without their consent, and 1 indicates invitees' consent is required for adding them to the team. Otherwise 414 is returned
msgStringYesText of the invitation sent, with a maximum length of 150 characters
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&members=["aaa","bbb"]&msg=welcome&magree=0' 'https://api-sg.netease.im/nimserver/team/add.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "faccid":{
         "accid":["a","b","c"],
         "msg":"team count exceed"
     }
}

If the number of invited people exceeds the team limit, the faccid will be returned

Valid status codes

200、403、414、416、431、500、801

See Status codes .


Remove a member from a team

Request URL

POST https://api-sg.netease.im/nimserver/team/kick.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

  1. Kick a member out of an advanced team. You must provide the team owner accid and the accid of the member to be kicked out of the team.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned when the team is created, with a maximum length of 128 characters
ownerStringYesadministrator's accid, user account, with up to 32 characters,
memberStringNoThe accid and user account of the person to be removed, with a maximum length of 32 characters; Note: either member or members is applicable, but the former is preferred
membersStringNo["aaa","bbb"] (accid corresponding to JSONArray, parsing error results in code 414), can operate with up to 200 accids at a time; either member or members is applicable, but the former is preferred
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&member=lisi' 'https://api-sg.netease.im/nimserver/team/kick.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Dismiss a team

Request URL

POST https://api-sg.netease.im/nimserver/team/remove.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

If the team is deleted, the team will be dismissed. You must provide the team owner accid. Proceed with caution.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned when the team is created, with a maximum length of 128 characters
ownerStringYesAccId of Team owner user, with a maximum length of 32 characters,
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan' 'https://api-sg.netease.im/nimserver/team/remove.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Edit the team profile

Request URL

POST https://api-sg.netease.im/nimserver/team/update.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Update the basic information about an advanced team.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
tnameStringNoTeam name, with a maximum length of 64 characters
ownerStringYesAccId of Team owner user, with a maximum length of 32 characters,
announcementStringNoTeam announcement, with a maximum length of 1024 characters
introStringNoTeam description, with a maximum length of 512 characters
joinmodeintNoWhen operating the sdk after creating the team, 0 indicates verification is not required, 1 indicates verification is required, and 2 indicates no one is allowed to join the team. For other values, return 414
customStringNoCustomizable extension attributes of an advanced team, and third parties can customize and extend their own teams' attributes based on this attribute. (json is recommended), with a maximum length of 1024 characters
iconStringNoTeam profile picture, with a maximum length of 1024 characters
beinvitemodeintNoWhether the invitee's consent is required, 0-consent required (default), 1- consent not required. For other values, return 414
invitemodeintNoWho can invite others to join the team, 0-administrator (default), 1-everyone. For other values, return 414
uptinfomodeintNoWho can update team profile, 0-administrator (default), 1-everyone. For other values, return 414
upcustommodeintNoWho can update custom team attributes, 0-administrator (default), 1-everyone. For other values, return 414
teamMemberLimitintNoThe maximum number of people in the team (including the owner), range: from 2 to the maximum number defined by the application (default: 200). For other values, return 414
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&tname=mygroup&owner=zhangsan' 'https://api-sg.netease.im/nimserver/team/update.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Query the team profile and member list

Request URL

POST https://api-sg.netease.im/nimserver/team/query.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

  1. When querying advanced Team profile and member list, up to 30 teams can be queried at one time, and you can control whether to attach a list of team members based on ope parameter;
  2. Team member query may be slightly slower, so you can just check the Team profile if you do not need a list of team members;
  3. This interface is subject to rate limit, with a maximum of 30 queries in a given application within one minute. If the queries exceed the limit, 416 will be returned and this interface will be shielded for a period of time;
  4. Add the return of admins to the list of team members.

Parameters

ParameterTypeRequiredDescription
tidsStringYesTeam ID list, examples include ["3083","3084"]
opeintYes1 indicates with team member list, 0 indicates without team member list, and only return team profile
ignoreInvalidBooleanNoWhether to ignore invalid tid, set to false in default. When set to true, any invalid tid will be ignored and returned in the response result
sizeNumberYesNumber of members in the team

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=["3083","3084","3085"]&ope=1&ignoreInvalid=true' "https://api-sg.netease.im/nimserver/team/query.action"

Response

The data returned in the HTTP response is in JSON format.

//Query team list information without team member list.
{
    "code": 200,
    "tinfos": [
        {
            "tname": "aa",
            "announcement": "aa",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3083,
            "intro": "test",
            "size": 4,
            "custom": "",
            "clientCustom": "",
            "mute": true,
            "createtime": 1506652312445,
            "updatetime": 1521082125400
        },
        {
            "tname": "bb",
            "announcement": "bb",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3084,
            "intro": "test",
            "size": 3,
            "custom": "",
            "clientCustom": "",
            "mute": false,
            "createtime": 1506652312445,
            "updatetime": 1521082125400
        }
    ],
    "invalidTids":[3085] //This field is only available when ignoreInvalid=true.
}
//Query team list information with team member list.
//Elements in field "members" contain administrators but not creators.
{
    "code": 200,
    "tinfos": [
        {
            "tname": "aa",
            "announcement": "aa",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3083,
            "intro": "test",
            "size": 3,
            "custom": "",
            "clientCustom": "",
            "mute": true,
            "createtime": 1506652312445,
            "updatetime": 1521082125400,
            "admins": [
                "v3"
            ],
            "members": [
                "v1",
                "v2",
                "v3"
            ]
        },
        {
            "tname": "bb",
            "announcement": "bb",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3084,
            "intro": "test",
            "size": 3,
            "custom": "",
            "clientCustom": "",
            "mute": false,
            "createtime": 1506652312445,
            "updatetime": 1521082125400,
            "admins": [
                "v3"
            ],
            "members": [
                "v1",
                "v2",
                "v3"
            ]
        }
    ],
    "invalidTids":[3085] //This field is only available when ignoreInvalid=true.
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Get the detailed team profile

Request URL

POST https://api-sg.netease.im/nimserver/team/queryDetail.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Query the detailed profile of a specified team (Team profile + member details)

Parameters

ParameterTypeRequiredDescription
tidlongYesTeam id, unique identifier of the team, returned upon team creation
#### curl request example
curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=3088' "https://api-sg.netease.im/nimserver/team/queryDetail.action"

Response

The data returned in the HTTP response is in JSON format.

{
    "code": 200,
    "tinfo": {
        "icon": null,
        "announcement": null,
        "uptinfomode": 0,
        "maxusers": 1000,
        "intro": null,
        "upcustommode": 0,
        "tname": "test",
        "beinvitemode": 1,
        "joinmode": 0,
        "tid": 17889,
        "invitemode": 1,
        "mute": false,
        "custom:"",
        "clientCustom":"",
        "createtime": 1506652312445,
        "updatetime": 1521082125400,
        "owner": {
            "createtime": 1506652312445,
            "updatetime": 1506655709409,
            "nick": "nick1",
            "accid": "user1",
            "mute": false,
            "custom": null
        },
        "admins": [
            {
                "createtime": 1506652312445,
                "updatetime": 1506671333528,
                "nick": "usernick2",
                "accid": "user2",
                "mute": false,
                "custom": ""
            }
        ],
        "members": [
            {
                "createtime": 1506652312445,
                "updatetime": 1506671333528,
                "nick": "usernick3",
                "accid": "user3",
                "mute": false,
                "custom": null
            },
            {
                "createtime": 1506652312445,
                "updatetime": 1506652312445,
                "nick": "usernick4",
                "accid": "user4",
                "mute": false,
                "custom": null
            }
        ]
    }
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Get details of read messages in the advanced team

Request URL

POST https://api-sg.netease.im/nimserver/team/getMarkReadInfo.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Get details of read messages

Parameters

ParameterTypeRequiredDescription
tidlongYesTeam id, unique identifier of the team, returned upon team creation
msgidlongYesMessage ID returned from the server when sending read status of team message
fromAccidStringYesAccount of the message sender
snapshotBooleanNoWhether read and unread count of accid list is returned, set to false in default.

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&msgid=1200510468189&fromAccid=user12&snapshot=true' "https://api-sg.netease.im/nimserver/team/getMarkReadInfo.action"

Response

The data returned in the HTTP response is in JSON format.

{
    "code": 200,
    "data": {
        "readSize": 2,
        "unreadSize": 1,
        "readAccids": [
            "user1","user2"
        ],
        "unreadAccids": [
            "user3"
        ],
    }
}

Valid status codes

200, 403, 414, 404, 500

See Status codes .


Transfer the ownership of the team

Request URL

POST https://api-sg.netease.im/nimserver/team/changeOwner.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

  1. Transfer the ownership of an advaned team.
  2. The owner can leave the team or become an ordinary member.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned when the team is created, with a maximum length of 128 characters
ownerStringYesAccId of Team owner user, with a maximum length of 32 characters,
newownerStringYesNew owner's account, with a maximum length of 32 characters,
leaveintYes1: Team owner leaves the team after being dismissed; 2: Team owner becomes a regular member after being dismissed. Otherwise return code 414
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&newowner=lisi&leave=1' 'https://api-sg.netease.im/nimserver/team/changeOwner.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200
}

Valid status codes

200、403、414、416、431、500、806

See Status codes .


Assgin an administrator

Request URL

POST https://api-sg.netease.im/nimserver/team/addadministrator.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Promote an ordinary member to administrator. You can add up to 10 members at a time.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned when the team is created, with a maximum length of 128 characters
ownerStringYesAccId of Team owner user, with a maximum length of 32 characters,
membersStringYes\["aaa","bbb"\] (accid corresponding to JSONArray, parsing error results in code 414), , with a maximum length of 1024 characters (can add up to 10 administrators at a time)
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&members=["aaa","bbb"]' 'https://api-sg.netease.im/nimserver/team/addadministrator.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Remove administrators

Request URL

POST https://api-sg.netease.im/nimserver/team/removeadministrator.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Remove multiple administrators at a time. You can remove up to 10 administrators at a time.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned when the team is created, with a maximum length of 128 characters
ownerStringYesAccId of Team owner user, with a maximum length of 32 characters,
membersStringYes\["aaa","bbb"\] (accid corresponding to JSONArray, parsing error results in code 414), with a maximum length of 1024 characters (can remove up to 10 administrators at a time)
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&members=["aaa","bbb"]' 'https://api-sg.netease.im/nimserver/team/removeadministrator.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Get the profile of a team that a user has joined

Request URL

POST https://api-sg.netease.im/nimserver/team/joinTeams.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Get the profile of an advanced team which a user has joined.

Parameters

ParameterTypeRequiredDescription
accidStringYesaccid of the user requesting query

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api-sg.netease.im/nimserver/team/joinTeams.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{  "code":200 ,
    "count":2,
    "infos":
      [
          {"owner":"t2","tname":"test1","maxusers":50,"tid":3620,"size":3, "custom":""},
          {"owner":"t1","tname":"test2","maxusers":50,"tid":3622,"size":4, "custom":""}
      ]
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Edit the display name of an account in the team

Request URL

POST https://api-sg.netease.im/nimserver/team/updateTeamNick.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Update the display name of a specified account in the team

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
ownerStringYesTeam owner accid
accidStringYesAccid of team member that wants to update team profile name
nickStringNoTeam display name corresponding to the accid, with a maximum length of 32 characters
customStringNoCustom extension field, with a maximum length of 1024 bytes

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&accid=lisi&nick=jack' 'https://api-sg.netease.im/nimserver/team/updateTeamNick.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Turn on or off the message alert

Request URL

POST https://api-sg.netease.im/nimserver/team/muteTeam.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Turn on or off the message alert for the advanced team

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
accidStringYesAccid of the targeted team member
opeintYes1: Disable message alert, 2: Enable message alert, other values are invalid

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=11111&accid=lisi&ope=1' 'https://api-sg.netease.im/nimserver/team/muteTeam.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Mute team members

Request URL

POST https://api-sg.netease.im/nimserver/team/muteTlist.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Mute advanced team members.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
ownerStringYesTeam owner accid
accidStringYesAccid of muted object
muteintYes1- mute, 0-unmute
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&accid=wangwu&mute=1' 'https://api-sg.netease.im/nimserver/team/muteTlist.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


leave an advanced team

Request URL

POST https://api-sg.netease.im/nimserver/team/leave.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

leave an advanced team.

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
accidStringYesAccid for drop-out
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&accid=wangwu' 'https://api-sg.netease.im/nimserver/team/leave.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Mute all team members

Request URL

POST https://api-sg.netease.im/nimserver/team/muteTlistAll.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Mute all team members. Team members cannot send messages. The owner and administrator can send messages

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
ownerStringYesOwner's accid
muteStringNotrue: mute, false: unmute (mute or muteType or both, but both indicates the same as mute)
muteTypeintNoType of mute 0: unmute, 1: mute regular member 3: mute the whole team (including the owner)
attachStringNoCustom extension field, with a maximum length of 512

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&mute=1' 'https://api-sg.netease.im/nimserver/team/muteTlistAll.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .


Get a list of muted teams

Request URL

POST https://api-sg.netease.im/nimserver/team/listTeamMute.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

For information about headers in the request, see Overview.

Get a list of muted team members

Parameters

ParameterTypeRequiredDescription
tidStringYesGenerated by CommsEase server, unique identifier of the team, returned upon team creation
ownerStringYesOwner's accid

curl request example

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=wangwu' 'https://api-sg.netease.im/nimserver/team/listTeamMute.action'

Response

The data returned in the HTTP response is in JSON format.

"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "mutes":[ 
    {"nick":"nick1","accid":"user1","tid":17874,"type":0}, 
    {"nick":"nick2","accid":"user2","tid":17874,"type":0} 
  ]
}

Valid status codes

200, 403, 414, 416, 431, 500

See Status codes .

Was this topic helpful?
Yes
No
  • Create a team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Invite a user to an advaned team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Remove a member from a team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Dismiss a team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Edit the team profile
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Query the team profile and member list
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Get the detailed team profile
  • Request URL
  • Parameters
  • Response
  • Valid status codes
  • Get details of read messages in the advanced team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Transfer the ownership of the team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Assgin an administrator
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Remove administrators
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Get the profile of a team that a user has joined
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Edit the display name of an account in the team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Turn on or off the message alert
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Mute team members
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • leave an advanced team
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Mute all team members
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes
  • Get a list of muted teams
  • Request URL
  • Parameters
  • curl request example
  • Response
  • Valid status codes