Adding a List

Last updated: 2020-03-12 10:26:42

PDF

Feature Description

This API is used to add a friend group. You can add friend groups in batches and add a specific friend to a friend group.

API Invocation Description

Request URL example

https://console.tim.qq.com/v4/sns/group_add?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.

Parameter Description
v4/sns/group_add The request API.
sdkappid The SDKAppID assigned by the IM console when an app is created.
identifier This must be the app admin account. For details, see App Admins.
usersig The signature generated by the app admin account. For details, see Generating UserSig.
random Enter a random 32-bit unsigned integer ranging from 0 to 4294967295.

Maximum invocation frequency

The maximum invocation frequency is 200 times per second.

Request packet examples

  • Basic form
    {
      "From_Account":"id",
      "GroupName":["group1","group2","group3"]
    }
  • Complete form
    {
      "From_Account":"id",
      "GroupName":["group1","group2","group3"],
      "To_Account":["id1","id2","id3"]
    }

Request packet fields

Field Type Attribute Description
From_Account String Required The identifier for which a new friend group needs to be added.
GroupName Array Required The list of new friend groups.
To_Account Array Optional The list of identifiers of friends that need to be added to the new friend group.

Response packet examples

  • Basic form
    {
      "CurrentSequence": 2,
      "ActionStatus": "OK",
      "ErrorCode": 0,
      "ErrorInfo": "",
      "ErrorDisplay": ""
    }
  • Complete format
    {
      "ResultItem":
      [
          {
              "To_Account": "id1",
              "ResultCode": 0,
              "ResultInfo": ""
          },
          {
              "To_Account": "id2",
              "ResultCode": 32216,
              "ResultInfo": "Err_SNS_GroupAdd_ToTinyId_Not_Friend"
          },
          {
              "To_Account": "id3",
              "ResultCode": 30002,
              "ResultInfo": "ERR_SDKAPPID_ILLEGAL"
          }
      ],
      "Fail_Account": ["id1"],
      "Invalid_Account": ["id3"],
      "CurrentSequence": 3,
      "ActionStatus": "OK",
      "ErrorCode": 0,
      "ErrorInfo": "",
      "ErrorDisplay": ""
    }

Response packet fields

Field Type Description
ResultItem Array The result object array for adding a friend to a new friend group.
To_Account String The identifier of the friend to be added to the new friend group.
ResultCode Integer The processing result of To_Account. 0: succeeded. Others: failed.
ResultInfo String Error description for To_Account. If the processing was successful, the field is empty.
Fail_Account Array Returns a list of users for whom the processing failed. This field is returned only when the processing failed for a user.
Invalid_Account Array Returns a list of users with inconsistent SDKAppIDs. This field is returned only when invalid users exist.
CurrentSequence Integer The current sequence of the friend group.
ActionStatus String The request processing result. OK: succeeded. FAIL: failed.
ErrorCode Integer The error code. 0: succeeded. Others: failed.
ErrorInfo String Detailed error information.
ErrorDisplay String Detailed error information to be displayed on the client.

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.

Error Code Description
30001 A request parameter is incorrect. In this case, check request parameters based on the error description.
30002 The SDKAppIDs are inconsistent.
30003 The requested user account does not exist.
30004 The request requires app admin permissions.
30005 A relationship chain field contains sensitive words.
30006 An internal server error occurred. In this case, try again.
30007 The network connection timed out. In this case, try again later.
30008 A write conflict occurred due to concurrent writes. In this case, we recommend that you use the batch mode.
30011 The number of groups has reached the upper limit of the system.

API Commissioning Tool

Use the online commissioning tool for RESTful APIs to commission this API.

References

Deleting a group (v4/sns/group_delete)