製品の説明

製品の概要

Basic Concepts

ユースケース

機能概要

アカウントシステム

ユーザープロフィールとリレーションシップチェーン

メッセージ管理

グループシステム

Official Account

Audio/Video Call

使用制限

購入ガイド

課金概要

価格説明

Purchase Instructions

Renewal Guide

支払い延滞説明

Refund Policy

ダウンロードセンター

SDK & Demo ソースコード

更新ログ

シナリオプラン

Live Streaming Setup Guide

AI Chatbot

極めて大規模なエンターテインメントコラボレーションコミュニティ

Discord実装ガイド

ゲーム内IM統合ガイド

WhatsApp Channel-style Official Account Integration Solution

Send Red Packet

Firewall Restrictions

クライアントAPIs

SDK API（Web）

Android

iOS & macOS

Swift

Flutter

SDK API（Electron）

SDK APIs (Unity)

SDK API（React Native）

C APIs

C++

サービス側 APIs

UserSigの生成

RESTful APIs

Webhooks

コンソールガイド

New Console Introduction

アプリケーションの作成とアップグレード

基本設定

機能設定

アカウント管理

グループ管理

Official Channel Management

コールバック設定

監視ダッシュボード

Viewing Guide for Resource Packages

Real-Time Monitor

補助ツールの開発

アクセス管理

Advanced Features

よくあるご質問

uni-app FAQs

購入に関する質問

SDKに関する質問

アカウント認証に関する質問

ユーザープロファイルとリレーションシップチェーンに関する質問

メッセージに関する質問

グループに関する質問

ライブ配信グループに関する質問

ニックネームプロフィール画像に関連した問題

一般的なリファレンス

Service Level Agreement

セキュリティコンプライアンス認証

IM ポリシー

プライバシーポリシー

データプライバシーとセキュリティ契約

エラーコード

お問い合わせ

Before a Friend Request Is Responded

PDF

フォーカスモード

フォントサイズ

最終更新日: 2024-08-20 17:11:03

Feature Description
This API is used by the app backend to:
View responses to friend requests in real time.
Block malicious responses to friend requests.
Notes
To enable this callback, you must configure a callback URL and toggle on the corresponding protocol. For more information on the configuration method, see Callback Configuration.
During this callback, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, see the Security Considerations section in Third-Party Callback Overview.
Callback Triggering Scenarios
An app user initiates a response to accept or reject a friend request.
Callback Triggering Timing
Chat backend receives a response from an app user to a friend request.
Caution: 
Responses initiated via RESTful API calls to friend requests will not trigger the callback.
API Calling Description
Sample request URL
In the following sample, the callback URL configured in the app is https://www.example.com.
Sample:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request parameters
Parameter
Description
https
The request protocol is HTTPS and the request method is POST.
www.example.com
Callback URL
SdkAppid
SDKAppID assigned by the Chat console when the app is created
CallbackCommand
Always Sns.CallbackPrevFriendResponse
contenttype
Always json
ClientIP
Client IP, such as 127.0.0.1
OptPlatform
Client platform. For valid values, see the description of OptPlatform in the Callback Protocols section of Third-Party Callback Overview.
Sample request
{
  "CallbackCommand": "Sns.CallbackPrevFriendResponse",
  "Requester_Account": "id",
  "From_Account": "id",
  "ResponseFriendItem": [
    {
      "To_Account": "id1",
      "Remark": "remark1",
      "TagName": "group1",
      "ResponseAction": "Response_Action_AgreeAndAdd"
    },
    {
      "To_Account": "id2",
      "Remark": "remark2",
      "TagName": "group2",
      "ResponseAction": "Response_Action_Reject"
    }
  ],
  "EventTime": 1631777645424
}
Request fields
Field
Type
Description
CallbackCommand
String
Callback command
Requester_Account
String
UserID of the user who initiates the friend request
From_Account
String
UserID of the user who responds to the friend request
ResponseFriendItem
Array
Parameter of the response to the friend request
To_Account
String
UserID of the user who makes the friend request
Remark
String
Friend remarks set by From_Account for To_Account. For more information, see the Standard friend fields section in Contacts Management.
TagName
String
Friend list set by From_Account for To_Account. For more information, see the Standard friend fields section in Contacts Management.
ResponseAction
String
Response method. Valid values:
Response_Action_AgreeAndAdd: accept the friend request and add the other party as friend.
Response_Action_Agree: agree to let the other party add you as friend.
Response_Action_Reject: reject the friend request.
EventTime
Integer
Timestamp in milliseconds
Sample response
{
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ResultItem": [
    {
      "To_Account": "id1",
      "ResultCode": 0,
      "ResultInfo": ""
    },
    {
      "To_Account": "id2",
      "ResultCode": 0,
      "ResultInfo": ""
    }
  ]
}
Response fields
Field
Type
Required
Description
ActionStatus
String
Yes
Request result. OK: successful; FAIL: failed
ErrorCode
Integer
Yes
Error code. Valid values:
0: processing by the app backend is successful.
Other values: processing by the app backend fails. The Chat backend ignores this error by default.
If the processing fails, set the error code to a value in the range of [38000, 39000].
ErrorInfo
String
Yes
Error information
ResultItem
Array
Yes
Processing result from the app backend
To_Account
String
Yes
UserID of the user who initiates the friend request
ResultCode
Integer
Yes
Result code. Valid values:
0: allow adding as friend.
Other values: do not allow adding as friend.
To not allow adding as friend, set the result code to a value in the range of [38000, 39000].
ResultInfo
String
Yes
Error information
References
Third-Party Callback Overview
Adding Friends

ヘルプとサポート

この記事はお役に立ちましたか？

営業担当者にお問い合わせいただくかチケットを提出してサポートを求めることができます。

フィードバック

Parameter	Description
https	The request protocol is HTTPS and the request method is POST.
www.example.com	Callback URL
SdkAppid	`SDKAppID` assigned by the Chat console when the app is created
CallbackCommand	Always `Sns.CallbackPrevFriendResponse`
contenttype	Always `json`
ClientIP	Client IP, such as 127.0.0.1
OptPlatform	Client platform. For valid values, see the description of `OptPlatform` in the Callback Protocols section of Third-Party Callback Overview.

Field	Type	Description
CallbackCommand	String	Callback command
Requester_Account	String	`UserID` of the user who initiates the friend request
From_Account	String	`UserID` of the user who responds to the friend request
ResponseFriendItem	Array	Parameter of the response to the friend request
To_Account	String	`UserID` of the user who makes the friend request
Remark	String	Friend remarks set by `From_Account` for `To_Account`. For more information, see the Standard friend fields section in Contacts Management.
TagName	String	Friend list set by `From_Account` for `To_Account`. For more information, see the Standard friend fields section in Contacts Management.
ResponseAction	String	Response method. Valid values: `Response_Action_AgreeAndAdd`: accept the friend request and add the other party as friend. `Response_Action_Agree`: agree to let the other party add you as friend. `Response_Action_Reject`: reject the friend request.
EventTime	Integer	Timestamp in milliseconds

Field	Type	Required	Description
ActionStatus	String	Yes	Request result. `OK`: successful; `FAIL`: failed
ErrorCode	Integer	Yes	Error code. Valid values: `0`: processing by the app backend is successful. Other values: processing by the app backend fails. The Chat backend ignores this error by default. If the processing fails, set the error code to a value in the range of [38000, 39000].
ErrorInfo	String	Yes	Error information
ResultItem	Array	Yes	Processing result from the app backend
To_Account	String	Yes	`UserID` of the user who initiates the friend request
ResultCode	Integer	Yes	Result code. Valid values: `0`: allow adding as friend. Other values: do not allow adding as friend. To not allow adding as friend, set the result code to a value in the range of [38000, 39000].
ResultInfo	String	Yes	Error information

tencent cloud

Chat

Before a Friend Request Is Responded

Feature Description

Notes

Callback Triggering Scenarios

Callback Triggering Timing

API Calling Description

Sample request URL

Request parameters

Sample request

Request fields

Sample response

Response fields

References

ヘルプとサポート