After a User Is Added to Blocklist

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

Feature Description
The app backend uses this callback view information about users added to the blocklist in real time.
Precautions
To enable this callback, you must configure the callback URL and toggle on the corresponding protocol. For details on the configuration method, see Third-Party Callback Configuration.
Callback direction: 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 consistent with its own SDKAppID.
For other security-related issues, see Third-Party Callback Overview: Security Considerations.
Callback Triggering Scenarios
An app user uses the client to initiate a request for adding a user to the blocklist.
The app backend initiates a request for adding a user to the blocklist through the RESTful API.
Callback Triggering Time
The callback is triggered when the Chat backend receives a request for adding a user to the blocklist and successfully adds the user to the blocklist.
API Description
Request URL example
In the following example, the callback URL configured in the app is https://www.example.com.
Example:
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
The callback URL.
SdkAppid
The SDKAppID assigned by the Chat console when an app is created.
CallbackCommand
The value is fixed to Sns.CallbackBlackListAdd.
contenttype
The value is fixed to JSON.
ClientIP
The client IP address, whose format is similar to: 127.0.0.1.
OptPlatform
The client platform. For details on the possible values, see the OptPlatform parameter in Third-Party Callback Overview: Callback Protocols.
Request packet example
{
    "CallbackCommand": "Sns.CallbackBlackListAdd",
    "PairList": [
        {
            "From_Account": "id",
            "To_Account": "id1"
        },
        {
            "From_Account": "id",
            "To_Account": "id2"
        },
        {
            "From_Account": "id",
            "To_Account": "id3"
        }
    ]
}
Request packet fields
Field
Type
Description
CallbackCommand
String
The callback command.
PairList
Array
The blocklist contacts pair that is successfully added.
From_Account
String
From_Account adds To_Account to the blocklist.
To_Account
String
To_Account is added to the blocklist of From_Account.
Response packet example
{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": ""
}
Response packet fields
Field
Type
Attribute
Description
ActionStatus
String
Required
The request processing result. OK: succeeded. FAIL: failed.
ErrorCode
Integer
Required
The error code. 0 indicates that the app backend processing succeeded, and 1 indicates that the app backend processing failed.
ErrorInfo
String
Required
Error information.
References
Third-Party callback overview
RESTful APIs: Adding users to the blocklist

tencent cloud

Recent Pages

After a User Is Added to Blocklist

Feature Description

Precautions

Callback Triggering Scenarios

Callback Triggering Time

API Description

Request URL example

Request parameters

Request packet example

Request packet fields

Response packet example

Response packet fields

References

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

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

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST.
www.example.com	The callback URL.
SdkAppid	The SDKAppID assigned by the Chat console when an app is created.
CallbackCommand	The value is fixed to Sns.CallbackBlackListAdd.
contenttype	The value is fixed to JSON.
ClientIP	The client IP address, whose format is similar to: 127.0.0.1.
OptPlatform	The client platform. For details on the possible values, see the OptPlatform parameter in Third-Party Callback Overview: Callback Protocols.

Field	Type	Description
CallbackCommand	String	The callback command.
PairList	Array	The blocklist contacts pair that is successfully added.
From_Account	String	From_Account adds To_Account to the blocklist.
To_Account	String	To_Account is added to the blocklist of From_Account.

Field	Type	Attribute	Description
ActionStatus	String	Required	The request processing result. OK: succeeded. FAIL: failed.
ErrorCode	Integer	Required	The error code. 0 indicates that the app backend processing succeeded, and 1 indicates that the app backend processing failed.
ErrorInfo	String	Required	Error information.

tencent cloud

サインアップ

ログイン

Recent Pages

After a User Is Added to Blocklist

Feature Description

Precautions

Callback Triggering Scenarios

Callback Triggering Time

API Description

Request URL example

Request parameters

Request packet example

Request packet fields

Response packet example

Response packet fields

References

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

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