tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Modifying Official Account Information

    Last updated: 2024-07-16 11:29:54
    Download PDF

      Feature Overview

      This API is used by the app administrator to modify relevant information of an official account, such as the name, avatar, and introduction.

      API Calling Description

      Sample Request URL

      https://xxxxxx/v4/official_account_open_http_svc/modify_official_account_base_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

      Request Parameters

      The table below only lists the parameters modified when this API is called and their descriptions. For details on the parameters, refer to RESTful API Overview.
      Parameter
      Description
      xxxxxx
      The dedicated domain name corresponding to the country/region of the SDKAppID:
      China: console.tim.qq.com
      Singapore: adminapisgp.im.qcloud.com
      Seoul: adminapikr.im.qcloud.com
      Frankfurt: adminapiger.im.qcloud.com
      Silicon Valley: adminapiusa.im.qcloud.com
      Jakarta: adminapiidn.im.qcloud.com
      v4/official_account_open_http_svc/modify_official_account_base_info
      Request API.
      sdkappid
      The SDKAppID assigned by the Chat console when an application is created.
      identifier
      The app admin account. For details, see App Admin.
      usersig
      The signature generated by the app admin account. For details, see Generating UserSig.
      random
      A random 32-bit unsigned integer ranging from 0 to 4294967295.
      contenttype
      The value is always json.

      Maximum Call Frequency

      200 times/second

      Sample Request Packets

      {
          "Official_Account": "@TOA#_@TOA#dOEF",
          "CustomString": "modify_custom_string",
          "FaceUrl": "http://this.is.face.url",
          "Introduction": "This is modify test Introduction",
          "Name": "test_modify_official_account",
          "Organization": "modify_organization",
          "MaxSubscriberNum":1000
      }

      Request Fields

      Field
      Type
      Required
      Description
      Official_Account
      String
      Yes
      ID of the official account to be modified. Use the OfficialAccountUserID field returned by the API during creation.
      Name
      String
      No
      Name of the official account, up to 150 bytes in length, using UTF-8 encoding, with 1 Chinese character occupying 3 bytes.
      Introduction
      String
      No
      Introduction to the official account, up to 400 bytes in length, using UTF-8 encoding, with 1 Chinese character occupying 3 bytes.
      FaceUrl
      String
      No
      Avatar of the official account, up to 500 bytes in length.
      Organization
      String
      No
      Group organization the official account belongs to, up to 500 bytes in length, using UTF-8 encoding, with 1 Chinese character occupying 3 bytes.
      CustomString
      String
      No
      The custom field of the official account, up to 3,000 bytes. It can be used by the application layer to meet the requirements of special scenarios.
      MaxSubscriberNum
      Integer
      No
      The maximum number of subscribers to an official account, with a default value of 100,000 when not specified.
      

      Sample Response Packets

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

      Response Fields

      Field
      Type
      Description
      ActionStatus
      String
      Processing result:
      OK: succeeded.
      FAIL: failed.
      ErrorCode
      Integer
      Error code:
      0: succeeded.
      Other values: failed.
      ErrorInfo
      String
      Error information.

      Error Codes

      Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packets represent the actual error code and error information. For common error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
      Error Code
      Description
      6017
      Invalid request parameter. Please modify and retry.
      10004
      Internal server error. Please try again.
      20001
      Invalid request packet. Please modify and retry.
      20005
      Internal server error. Please try again.
      130002
      Insufficient operation permissions. Please check the request parameters based on the error message.
      130004
      The official account user does not exist, or once existed but has now been terminated.
      130007
      Incorrect official account user ID. Please modify and retry.
      130008
      The official account user ID is already in use. Please modify and retry.
      131000
      This AppId has not been enabled with official account service. Please enable it and retry.

      References

      Possibly Triggered Callbacks

      After Official Account Information Is Modified (<1>)
      
      
      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