tencent cloud

Feedback

Marking One-to-One Messages as Read

Last updated: 2022-05-18 14:25:38

    Overview

    This API is used to mark the messages of a one-to-one conversation as read.

    API Calling Description

    Sample request URL

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

    Request parameters

    The following table describes only the modified parameters when this API is called. For other parameters, see RESTful API Overview.

    Parameter Description
    https The request protocol is HTTPS, and the request method is POST.
    xxxxxx Domain name corresponding to the country/region where your SDKAppID is located.
  • Chinese mainland: console.tim.qq.com
  • Singapore: adminapisgp.im.qcloud.com
  • Seoul: adminapikr.im.qcloud.com
  • Frankfurt: adminapiger.im.qcloud.com
  • India: adminapiind.im.qcloud.com
  • v4/openim/admin_set_msg_read Request API
    sdkappid SDKAppID assigned by the IM console when an app is created
    identifier App admin account. For more information, see the App Admin section in Login Authentication.
    usersig Signature generated by the app admin account. For operation details, see Generating UserSig.
    random A random 32-bit unsigned integer ranging from 0 to 4,294,967,295
    contenttype Request format, which should always be json.

    Maximum call frequency

    200 calls per second

    Sample request

    The admin specifies that dramon1 marks all the messages of its one-to-one conversation with dramon2 as read.

    {
     "Report_Account":"dramon1",
     "Peer_Account":"dramon2"
    }
    

    Request fields

    Field Type Required Description
    Report_Account String Yes UserId of the account for which to mark messages as read
    Peer_Account String Yes UserId of the other account in the one-to-one conversation
    MsgReadTime String No Timestamp (in seconds). All messages before the specified timestamp are marked as read. If no value is specified, the current timestamp is used.

    Sample response

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

    Response fields

    Field Type Description
    ActionStatus String Request result. OK: Successful; FAIL: Failed
    ErrorCode Integer Error code. 0: Successful; other values: Failed
    ErrorInfo String Error information

    Error Codes

    The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively.
    For public error codes (60000 to 79999), see Error Codes.
    The following table describes the error codes specific to this API:

    Error Code Description
    90001 Failed to parse the JSON request. Make sure the format is valid.
    90003 The To_Account field is missing in the JSON request, or the account specified by To_Account does not exist.
    90008 The From_Account field is missing in the JSON request, or the account specified by From_Account does not exist.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.

    References

    Contact Us

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

    Technical Support

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

    7x24 Phone Support