tencent cloud

文档反馈

添加好友回应之前回调

最后更新时间:2024-02-19 11:01:45

    功能说明

    App 后台可以通过该回调实时查看用户的加好友回应请求,包括:
    实时查看用户的加好友回应请求。
    拦截恶意加好友回应请求。

    注意事项

    要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详见 第三方回调配置 文档。
    回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
    App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
    其他安全相关事宜请参考 第三方回调简介:安全考虑 文档。

    可能触发该回调的场景

    App 用户通过客户端发起加好友回应请求,同意/拒绝添加好友。

    回调发生时机

    即时通信 IM 后台收到来自 App 的加好友回应请求后。
    注意:
    通过 REST API 发起的加好友回应请求不会触发回调。

    接口说明

    请求 URL 示例

    以下示例中 App 配置的回调 URL 为 https://www.example.com示例:
    https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

    请求参数说明

    参数
    说明
    https
    请求协议为 HTTPS,请求方式为 POST
    www.example.com
    回调 URL
    SdkAppid
    创建应用时在即时通信 IM 控制台分配的 SDKAppID
    CallbackCommand
    固定为:Sns.CallbackPrevFriendResponse
    contenttype
    固定值为:json
    ClientIP
    客户端 IP,格式如:127.0.0.1
    OptPlatform
    客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

    请求包示例

    {
    "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
    }

    请求包字段说明

    字段
    类型
    说明
    CallbackCommand
    String
    回调命令
    Requester_Account
    String
    添加好友回应请求发起方的 UserID
    From_Account
    String
    请求加好友回应的用户的 UserID
    ResponseFriendItem
    Array
    加好友回应请求的参数
    To_Account
    String
    请求回应的用户的 UserID
    Remark
    String
    From_Account 对 To_Account 设置的好友备注,详情可参见 标配好友字段
    TagName
    String
    From_Account 对 To_Account 设置的好友分组,详情可参见 标配好友字段
    ResponseAction
    String
    加好友回应方式:
    Response_Action_AgreeAndAdd 表示同意且添加对方为好友
    Response_Action_Agree 表示同意对方加自己为好友
    Response_Action_Reject 表示拒绝对方的加好友请求
    EventTime
    Integer
    毫秒时间戳

    应答包示例

    {
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ResultItem": [
    {
    "To_Account": "id1",
    "ResultCode": 0,
    "ResultInfo": ""
    },
    {
    "To_Account": "id2",
    "ResultCode": 0,
    "ResultInfo": ""
    }
    ]
    }

    应答包字段说明

    字段
    类型
    属性
    说明
    ActionStatus
    String
    必填
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    必填
    错误码:
    0表示 App 后台处理成功
    非0值表示 App 后台处理失败,默认放过
    如果 App 后台处理失败,请将错误码设置在[38000, 39000]
    ErrorInfo
    String
    必填
    错误信息
    ResultItem
    Array
    必填
    App 后台的处理结果
    To_Account
    String
    必填
    请求添加的用户的 UserID
    ResultCode
    Integer
    必填
    错误码:
    0表示允许加好友
    非0值表示不允许加好友
    如果不允许加好友,请将错误码设置在[38000, 39000]
    ResultInfo
    String
    必填
    错误信息

    参考

    REST API:添加好友
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持