tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    After Official Account Profile Is Modified

    Last updated: 2024-06-18 16:08:51
    Download PDF

      Feature Overview

      Through this webhook, the app backend can view changes to Official Account Information (such as Official Account Name, Official Account Description, Official Account Avatar, etc.) in real time, including realtime records of changes to Official Account Information (e.g., logging or syncing to other systems).

      Notes

      To enable the webhook, you must configure a webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Webhook Configuration.
      During this webhook, the Chat backend initiates an HTTP POST request to the app backend.
      After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
      For other security-related matters, please refer to the Webhook Introduction: Security Considerations.

      Webhook Triggering Scenarios

      App admins modify Official Account information through REST API

      Webhook Triggering Timing

      After Successfully Modifying Official Account Information

      API Calling Description

      Sample request URL

      In the subsequent example, the webhook URL configured within 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
      Webhook URL
      SdkAppid
      SDKAppID allocated by the Instant Messaging console at the time of Application creation
      CallbackCommand
      Set to: OfficialAccount.CallbackAfterOfficialAccountInfoChanged
      contenttype
      Fixed value: JSON
      ClientIP
      Client IP, such as 127.0.0.1
      OptPlatform
      Client platform, for values refer to webhook introduction: Webhook protocol with regards to the parameter meanings of OptPlatform

      Sample request

      {
          "CallbackCommand": "OfficialAccount.CallbackAfterOfficialAccountInfoChanged", // Callback command
          "Official_Account" : "@TOA#_test_OA_for_penn",
          "Operator_Account": "leckie", // Operator
          "Introduction": "NewNotification", // Updated official account introduction
          "Name": "NewName",		// Updated official account name
          "FaceUrl": "http://this.is.newface.url"	// Updated official account profile photo
        	"Organization": "NewOrganization"		// Updated official account organization
          "EventTime": 1670574414123// Event trigger timestamp in milliseconds		
      }

      Request fields

      Object
      Features
      Feature
      CallbackCommand
      String
      Webhook command
      Operator_Account
      String
      Initiator's UserID
      Official_Account
      String
      Created Official Account ID
      Introduction
      String
      Updated official account introduction
      Name
      String
      Updated Official Account Name
      FaceUrl
      String
      Updated Official Account Avatar
      Organization
      String
      Updated Official Account Affiliated Organization
      EventTime
      Integer
      Event trigger timestamp in milliseconds

      Sample response

      Following data synchronization, the app backend dispatches a webhook response packet.
      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0 
      }

      Response fields

      Field
      Type
      Attribute
      Description
      ActionStatus
      String
      Mandatory
      Results of the request processing
      OK: Indicates successful processing
      FAIL: Indicates failure
      ErrorCode
      Integer
      Mandatory
      Error Code, entering 0 here means to ignore the response result
      ErrorInfo
      String
      Mandatory
      Error message

      References

      Webhook Overview
      Modify Official Account Information
      
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy