tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
Chat
    문서
    Download PDF

    After a Profile Is Updated

    마지막 업데이트 시간:2024-08-20 17:11:03
    PDF 다운로드

      Feature Description

      This callback allows you to view the profile update operations by users in real time on the app backend.

      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

      App users modify their profiles through the client.
      App admins modify user profiles through RESTful APIs.

      Callback Triggering Timing

      This callback is triggered after the user profile is successfully modified.

      API Description

      Sample request URL

      In the following sample, 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
      Callback URL
      SdkAppid
      The SDKAppID assigned by the Chat console when the app is created
      CallbackCommand
      Fixed value: Profile.CallbackPortraitSet.
      contenttype
      Fixed value: json
      ClientIP
      Client IP, such as 127.0.0.1
      OptPlatform
      Client platform. For valid values, see the description of OptPlatform in the Callback Protocol section of Third-Party Callback Overview.

      Sample request

      {
        "CallbackCommand": "Profile.CallbackPortraitSet",
        "Operator_Account": "id1",
        "From_Account": "id1",
        "EventTime": 1656921052497,
        "ProfileItem": [
          {
            "Tag": "Tag_Profile_IM_Nick",
            "Value": "nick1"
          },
          {
            "Tag": "Tag_Profile_IM_Gender",
            "Value": "Gender_Type_Male"
          },
          {
            "Tag": "Tag_Profile_IM_AllowType",
            "Value": "AllowType_Type_NeedConfirm"
          },
          {
            "Tag": "Tag_Profile_Custom_Data",
            "Value": "your custom data"
          }
        ]
      }

      Request fields

      Field
      Type
      Description
      CallbackCommand
      String
      Callback command
      Operator_Account
      String
      UserID of the user who triggers the update operation
      From_Account
      String
      UserID of the user who updates the profile
      EventTime
      Integer
      Timestamp in milliseconds
      ProfileItem
      Array
      List of successfully updated user profile items
      Tag
      String
      Field name of the successfully updated profile. For more information, see Profile Management.
      Value
      uint32/string
      Value of the successfully updated profile field. For more information, see Profile Management.

      Sample response

      {
          "ActionStatus": "OK",
          "ErrorCode": 0,
          "ErrorInfo": ""
      }

      Response fields

      Field
      Type
      Required
      Description
      ActionStatus
      String
      Yes
      Request result. OK: succeeded; FAIL: failed.
      ErrorCode
      Integer
      Yes
      Error code. 0: the app backend processing succeeded; 1: the app backend processing failed.
      ErrorInfo
      String
      Yes
      Error information

      References

      Third-Party Callback Overview
      문의하기

      고객의 업무에 전용 서비스를 제공해드립니다.

      문의하기
      기술 지원

      더 많은 도움이 필요하시면, 티켓을 통해 연락 바랍니다. 티켓 서비스는 연중무휴 24시간 제공됩니다.

      티켓 제출
      연중무휴 24시간 전화 지원
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      개인정보 처리방침서비스 약관쿠키 정책