제품 개요
Basic Concepts
응용 시나리오
기능 소개
계정 시스템
사용자 정보 및 관계망
메시지 관리
그룹 시스템
Official Account
Audio/Video Call
사용 제한
https://xxxxxx/v4/sns/friend_get?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comTokyo： adminapijpn.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/sns/friend_get | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json. |
{"From_Account": "id","StartIndex": 0,"StandardSequence": 0,"CustomSequence": 0}
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. |
{"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": ""}
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 | |
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 | |
ErrorInfo | String | Detailed error information |
ErrorDisplay | String | Detailed information displayed on the client |
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. |
피드백