tencent cloud

PrevNext

フィードバック

キーワードで検索してください

Recent Pages

ドキュメント
Chat
    ドキュメント
    Download PDF

    Pulling Friends

    最終更新日:2024-07-16 11:25:50
    PDFファイルをダウンロード

      Feature Overview

      This API is used to pull the data of all friends by page.
      It cannot pull profile data.
      You do not need to specify the fields to pull. By default, all standard and custom friend data will be returned.

      API Calling Description

      Sample request URL

      https://xxxxxx/v4/sns/friend_get?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
      Jakarta: adminapiidn.im.qcloud.com
      v4/sns/friend_get
      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 requests

      {
          "From_Account": "id",
          "StartIndex": 0,
          "StandardSequence": 0,
          "CustomSequence": 0
      }

      Request fields

      Field
      Type
      Required
      Description
      From_Account
      String
      Yes
      The UserID of the account that requests to pull friend data
      StartIndex
      Integer
      Yes
      The starting point of the page to be pulled
      StandardSequence
      Integer
      No
      The StandardSequence returned for the previous friend data pull. If the value of the StandardSequence field is the same as that in the backend, the backend will not return standard friend data.
      CustomSequence
      Integer
      No
      The CustomSequence returned for the previous friend data pull. If the value of the CustomSequence field is the same as that in the backend, the backend will not return custom friend data.

      Sample responses

      {
          "UserDataItem": [
              {
                  "To_Account": "id1",
                  "ValueItem": [
                      {
                          "Tag": "Tag_SNS_IM_AddSource",
                          "Value": "AddSource_Type_Android"
                      },
                      {
                          "Tag": "Tag_SNS_IM_Remark",
                          "Value": "Remark1"
                      },
                      {
                          "Tag": "Tag_SNS_IM_Group",
                          "Value":["Group1","Group2"]
                      },
                      {
                          "Tag": "Tag_SNS_IM_AddTime",
                          "Value": 1563867420
                      },
                      {
                          "Tag": "Tag_SNS_Custom_Test",
                          "Value": "CustomData1"
                      }
                  ]
              },
              {
                  "To_Account": "id2",
                  "ValueItem": [
                      {
                          "Tag": "Tag_SNS_IM_AddSource",
                          "Value": "AddSource_Type_IOS"
                      },
                      {
                          "Tag": "Tag_SNS_IM_Group",
                          "Value":["Group1"]
                      },
                      {
                          "Tag": "Tag_SNS_IM_AddTime",
                          "Value": 1563867425
                      }
                  ]
              }
          ],
          "StandardSequence": 88,
          "CustomSequence": 46,
          "FriendNum": 20,
          "CompleteFlag": 1,
          "NextStartIndex": 0,
          "ActionStatus": "OK",
          "ErrorCode": 0,
          "ErrorInfo": "",
          "ErrorDisplay": ""
      }

      Response fields

      Field
      Type
      Description
      UserDataItem
      Array
      The friend object array. Each friend object contains a To_Account field and a ValueItem array.
      To_Account
      String
      The UserID of a friend
      ValueItem
      Array
      The array for storing friend data. Each array element contains a Tag field and a Value field.
      Tag
      String
      The name of a friend field
      Value
      String/Integer/Array
      The value of the friend field. For more information, see Relationship Chain Fields.
      StandardSequence
      Integer
      The sequence for standard friend data. The client can save this sequence and return it to the backend via the StandardSequence field in the next request.
      CustomSequence
      Integer
      The sequence for custom friend data. The client can save this sequence and return it to the backend via the CustomSequence field in the next request.
      FriendNum
      Integer
      The total number of friends
      CompleteFlag
      Integer
      The ending tag of the page. A non-zero value indicates that all friend data is pulled.
      NextStartIndex
      Integer
      The starting point of the next page
      ActionStatus
      String
      The request result. OK: successful. FAIL: 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 ErrorCode and ErrorInfo respectively. 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.
      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.

      API Debugging Tool

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

      Reference

      Adding Friends
      Importing Friends
      Updating Friends
      Deleting Friends
      Deleting All Friends
      Verifying Friends
      Pulling Specified Friends
      お問い合わせ

      カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

      お問い合わせ
      テクニカルサポート

      さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

      チケットを送信
      電話サポート（24 時間365日対応）
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      個人情報保護方針利用規約クッキーポリシー