please select
  • UIKit
  • SDK
  • Server APIs
Chat/
Server APIs/
RESTful APIs/
User Management/
Friend Management/
Server APIs
  • Generating UserSig
  • RESTful APIs
    • RESTful API Overview
    • RESTful API List
    • Message Related
      • Send Message
        • Sending One-to-One Messages to One User
        • Sending One-to-One Messages to Multiple Users
        • Sending Ordinary Messages in a Group
        • Sending System Messages in a Group
        • Broadcast Message of Audio-Video Group
        • Importing One-to-One Messages
        • Importing Group Messages
      • Historical Message
        • Modifying Historical One-to-one Messages
        • Modifying Historical Group Messages
        • Pulling Historical One-to-one Messages
        • Pulling Historical Group Messages
      • Delete Message
        • Deleting Messages Sent by a Specified User
      • Withdraw Message
        • Recalling One-to-One Messages
        • Recalling Group Messages
      • Read Receipt
        • Marking One-to-One Messages as Read
        • Pulling Group Message Read Receipt Details
        • Pulling Read Receipts for Group Messages
      • Message Extension
        • Pulling the Message Extension of a One-to-One Message
        • Configuring Message Extension for a One-to-One Message
        • Pulling Message Extension of a Group Message
        • Configuring Message Extension for a Group Message
      • Pushing to All Users
        • API for Pushing to All Users
        • Pushing to All Users
        • Setting Application Attribute Names
        • Getting Application Attribute Names
        • Getting User Attributes
        • Setting User Attributes
        • Deleting User Attributes
        • Getting User Tags
        • Adding User Tags
        • Deleting User Tags
        • Deleting All Tags of a User
    • Session Related
      • Conversation List
        • Pulling a conversation list
      • Session Unread Count
        • Setting the Unread Message Count of a Member
        • Querying Unread One-to-One Message Count
      • Delete Session
        • Deleting a conversation
      • Session Grouping Tag
        • Creating Conversation Group Data
        • Updating Conversation Group Data
        • Deleting Conversation Group Data
        • Creating or Updating Conversation Mark Data
        • Searching for Conversation Group Marks
        • Pulling Conversation Group Mark Data
    • Group Related
      • Group Management
        • Getting All Groups in an App
        • Creating a Group
        • Disbanding a Group
        • Getting the Groups a User Has Joined
      • Group Information
        • Getting Group Profiles
        • Modifying the Profile of a Group
        • Importing a Group Profile
      • Group Member Management
        • Adding Group Members
        • Deleting Group Members
        • Banning Group Members
        • Unbanning Group Members
        • Bulk Muting and Unmuting
        • Getting the List of Muted Group Members
        • Changing Group Owner
        • Querying the Roles of Users in a Group
        • Importing Group Members
      • Group Member Information
        • Getting Group Member Profiles
        • Modifying the Profile of a Group Member
      • Group Custom Attributes
        • Getting Group Custom Attributes
        • Modifying Group Custom Attributes
        • Clearing Group Custom Attributes
        • Resetting Group Custom Attributes
        • Deleting Group Custom Attributes
      • Live Group Management
        • Getting the Number of Online Users in an Audio-Video Group
        • Getting the List of Online Members in Audio-Video Group
        • Setting Audio-Video Group Member Marks
        • Getting the List of Banned Group Members.
      • Community Management
        • Creating Topic
        • Deleting Topic
        • Getting Topic Profile
        • Modifying Topic Profile
        • Importing Topic Profiles
      • Group Counter
        • Getting Group Counters
        • Updating Group Counters
        • Deleting Group Counters
    • User Management
      • Account Management
        • Importing a Single Account
        • Importing Multiple Accounts
        • Deleting Accounts
        • Querying Accounts
      • User Information
        • Setting Profiles
        • Pulling Profiles
      • User Status
        • Invalidating Account Login States
        • Querying Account Online Status
      • Friend Management
        • Adding Friends
        • Importing Friends
        • Updating Friends
        • Deleting Friends
        • Deleting All Friends
        • Verifying Friends
        • Pulling Friends
        • Pulling Specified Friends
      • Friend Lists
        • Adding Lists
        • Deleting Lists
        • Pulling Lists
      • Blocklist
        • Blocklisting Users
        • Unblocklisting Users
        • Pulling a Blacklist
        • Verifying Users on a Blocklist
    • Global Mute Management
      • Setting Global Mute
      • Querying Global Mute
    • Operations Management
      • Pulling Operations Data
      • Downloading Recent Messages
      • Getting Server IP Addresses
    • Chatbots
      • Pulling Chatbot Accounts
      • Creating Chatbot Accounts
      • Deleting Chatbot Accounts
  • Webhooks
    • Webhook Overview
    • Webhook Command List
    • Operations Management Callbacks
      • API Overclocking Alarm Callbacks
    • Online Status Webhooks
      • Status Change Webhooks
    • Relationship Chain Webhooks
      • After a Profile Is Updated
      • Before a Friend Is Added
      • Before a Friend Request Is Responded
      • After a Friend Is Added
      • After a Friend Is Deleted
      • After a User Is Added to Blocklist
      • After a User Is Removed from Blocklist
    • One-to-One Message Webhooks
      • Before a One-to-One Message Is Sent
      • After a One-to-One Message Is Sent
      • After a One-to-One message Is Marked as Read
      • After A One-to-One Message Is Recalled
    • Group Webhooks
      • Before a Group Is Created
      • After a Group Is Created
      • Before Applying to Join a Group
      • Before Inviting a User to a Group
      • After a User Joins a Group
      • After a User Leaves a Group
      • Before Group Message Is Sent
      • After a Group Message Is Sent
      • After a Group Is Full
      • After a Group Is Disbanded
      • After Group Profile Is Modified
      • Callback After Recalling Group Messages
      • Webhook for Online and Offline Status of Audio-Video Group Members
      • Webhook for Exceptions When Group Messages Are Sent
      • Before a Topic Is Created
      • After a Topic Is Created
      • After a Topic Is Deleted
      • Topic Profile Change Webhook
      • Callback After Group Member Profile Changed
      • Callback After Group Attribute Changed
      • Callback After Read Receipt
      • Callback After the Group Owner Changed
    • Webhook Mutual Authentication Configuration Guide
      • Apache Mutual Authentication Configuration
      • Nginx Mutual Authentication Configuration
    • Chatbot webhooks
      • Chatbot Passthrough Message Callback
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
User Management/
Friend Management/
Adding Friends/

Adding Friends

Feature Overview

This API is used to add one or multiple users to the friend list.

API Calling Description

Sample request URL

https://xxxxxx/v4/sns/friend_add?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
v4/sns/friend_add
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.

Maximum call frequency

200 calls per second

Sample request

Basic format
{
  "From_Account":"id",
  "AddFriendItem":
  [
      {
          "To_Account":"id1",
          "AddSource":"AddSource_Type_XXXXXXXX"
      }
  ]
}
Response to a complete request
{
  "From_Account":"id",
  "AddFriendItem":
  [
      {
          "To_Account":"id1",
          "Remark":"remark1",
          "GroupName":"Classmates", // Each user can only be assigned to one friend list when the user is added as a friend. Therefore, we can use `String` as the data type.
          "AddSource":"AddSource_Type_XXXXXXXX",
          "AddWording":"I'm Test1"
      }
  ],
  "AddType":"Add_Type_Both",
  "ForceAddFlags":1
}
Response to a batch request
{
  "From_Account":"id",
  "AddFriendItem":
  [
      {
          "To_Account":"id1",
          "AddSource":"AddSource_Type_XXXXXXXX"
      },
      {
          "To_Account":"id2",
          "Remark":"remark2",
          "GroupName":"Classmates", // Each user can only be assigned to one friend list when the user is added as a friend. Therefore, we can use `String` as the data type.
          "AddSource":"AddSource_Type_XXXXXXXX",
          "AddWording":"I'm Test2"
      },
      {
          "To_Account":"id3",
          "Remark":"remark3",
          "GroupName":"Colleagues", // Each user can only be assigned to one friend list when the user is added as a friend. Therefore, we can use `String` as the data type.
          "AddSource":"AddSource_Type_XXXXXXXX",
          "AddWording":"I'm Test3"
      }
  ],
  "AddType":"Add_Type_Both",
  "ForceAddFlags":1
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
The UserID that initiates the request.
AddFriendItem
Array
Yes
An array of friend objects.
To_Account
String
Yes
The UserID to add as a friend.
Remark
String
No
Friend remarks set by From_Account for To_Account. For more information, see the Standard friend fields section in Relationship Chain Management.
GroupName
String
No
The friend list that the user who initiates the friend request assigns to the user to be added. Each user can only be assigned to one friend list. Therefore, we can use the String data type. For details, see the standard friend fields section in Relationship Chain Management.
AddSource
String
No
Source from which a friend is added. For more information, see the Standard friend fields section in Relationship Chain Management.
AddWording
String
No
Remarks that the user who initiates the friend request writes about the user to be added. For details, see the standard friend fields section in Relationship Chain Management.
AddType
String
No
Friend adding type:
Add_Type_Single: one-sided
Add_Type_Both (default): mutual
ForceAddFlags
Integer
No
Flag denoting the friend is force added by an administrator: 1 means force added while 0 means the friend is added normally.

Sample response

Response to a basic or complete request
{
  "ResultItem":
  [
      {
          "To_Account":"id1",
          "ResultCode":0,
          "ResultInfo":""
      }
  ],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
}
Response to a batch request
{
  "ResultItem":
  [
      {
          "To_Account":"id1",
          "ResultCode":0,
          "ResultInfo":""
      },
      {
          "To_Account":"id2",
          "ResultCode":30006,
          "ResultInfo":"Err_SNS_FriendAdd_Unpack_Profile_Data_Fail"
      },
      {
          "To_Account":"id3",
          "ResultCode":30002,
          "ResultInfo":"Err_SNS_FriendAdd_SdkAppId_Illegal"
      }
  ],
  "Fail_Account":["id2","id3"],
  "ActionStatus":"OK",
  "ErrorCode":0,
  "ErrorInfo":"",
  "ErrorDisplay":""
}

Response fields

Field
Type
Description
ResultItem
Array
The result of adding friends in bulk, which is an array of UserIDs and corresponding results.
To_Account
String
The UserID that you requested to add as a friend.
ResultCode
Integer
The result. 0 means success and other values mean failure. For details on non-zero results, see Error Codes.
ResultInfo
String
Error description of To_Account. This field is empty if the request is successful.
Fail_Account
Array
List of users whose processing failed. This field is only returned when at least one user fails.
ActionStatus
String
The result of the request. OK means the request was successful. FAIL means the request failed.
ErrorCode
Integer
Error code. 0: Successful. Other values: Failed. For details on non-zero results, see Error Codes.
ErrorInfo
String
Detailed error information.
ErrorDisplay
String
Detailed information displayed on the client.


Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ResultCode, ResultInfo, ErrorCode, and ErrorInfo. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
Error Code
Description
30001
Incorrect request parameter. Check your request according to the error description.
30002
The SDKAppID does not match.
30003
The requested account does not exist.
30004
The request requires app admin permissions.
30006
Internal server error. Try again.
30007
Network timeout. Try again later.
30008
A write conflict occurred due to concurrent write operations. You are advised to use bulk processing.
30009
You have been prohibited from adding friends.
30010
Your friend list is full.
30011
The maximum number of friend lists has been reached.
30012
You have too many pending friend requests.
30014
The user you are trying to add has too many friends.
30515
The user you are trying to add is on your blocklist. You cannot add this user.
30516
The user you are trying to add has disabled friend requests.
30525
You have been blocklisted by the user you are trying to add. You cannot add this user.
30539
The user you are trying to add has selected AllowType_Type_NeeedConfirm as their friend request authentication method. Your friend request is pending approval. This code is used to differentiate a successful friend request, meaning the friend is added, and a pending friend request, so more helpful messages can be displayed.
30540
You have sent too many friend requests in a short amount of time. Request filtered for security reasons.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References

Importing Friends (v4/sns/friend_import)
Updating Friends (v4/sns/friend_update)
Deleting Friends (v4/sns/friend_delete)
Deleting All Friends (v4/sns/friend_delete_all)
Verifying Friends (v4/sns/friend_check)
Pulling Friends (v4/sns/friend_get)
Pulling Specified Friends (v4/sns/friend_get_list)