tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Create Callback Configuration

    Last updated: 2024-06-12 11:46:26
    Download PDF

      Feature Overview

      App administrators can create callback configurations through this API.

      API Calling Description

      Sample Request URL

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

      Request Parameters

      The table below only lists the parameters modified when calling this API. For more details, please refer to RESTful API Overview.
      Parameter
      Description
      xxxxxx
      The reserved domain name for the country/region where the SDKAppID is located:
      Singapore :adminapisgp.im.qcloud.com
      v4/room_config/set_callback
      Request API
      sdkappid
      The SDKAppID assigned by the Chat console when an app is created
      identifier
      Must be an App administrator account. For more details, please refer to App Administrator.
      usersig
      The Signature generated by the App administrator account. For more details, please refer to Generating UserSig.
      random
      Enter a random 32-bit unsigned integer ranging from 0 to 4294967295
      contenttype
      The request format fixed value is json

      Maximum Calling Frequency

      200 times per second.

      Sample Request Packets

      Basic Form
      {
        "Url":"http://www.example.com/callback",
        "CallbackCommandList":[
            "Room.CallbackAfterMemberLeave",
            "Mic.CallbackAfterSeatInfoChanged"
        ]
      }

      Request Packet Field Description

      Field
      Type
      Attribute
      Description
      Url
      String
      Mandatory
      Callback address, must start with http/https, it is recommended to use the more secure https.
      CallbackCommandList
      Array
      Mandatory
      For the command words that trigger the callback, refer to Callback Command Word List.

      Sample Response Packets

      Basic Form
      {
        "ActionStatus": "OK",
        "ErrorInfo": "",
        "ErrorCode": 0,
        "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
      }

      Response Packet Field Description

      Field
      Type
      Description
      ActionStatus
      String
      The result of the request process. OK for success, FAIL for failure.
      ErrorCode
      Integer
      Error code. 0 for success, others for failure.
      ErrorInfo
      String
      Error message
      RequestId
      String
      The unique request ID is returned with each request and required to provide this RequestId when locating issues.

      Error Codes

      Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body. For common error codes (60000 to 79999), see Error Code documentation. The private error codes for this API are as follows:
      Error code
      Description
      100001
      Internal server error, please retry.
      100002
      The parameter is invalid, please check the request for correctness based on the error description.
      100300
      Callback configuration already exists, you can use the Update Callback Configuration interface to update.
      
      
      
      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