過去のグルップチャットメッセージの変更
API Calling Description
This API is used by the admin to modify historical group chat messages.
You can modify the
MsgBody and CloudCustomData fields individually or at the same time for a message by overwriting the field values in a historical message with those specified in requests.This API cannot be used to modify the historical messages of audio-video groups.
Note
Messages modified by this API cannot be restored.
Sample request URL
https://xxxxxx/v4/openim/modify_group_msg?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 |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/openim/modify_group_msg | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json. |
Maximum call frequency
200 calls per second
Sample request
Modifying only the MsgBody information of the message object
{"GroupId": "@TGS#1HYEP2SHC","MsgSeq": 23,"MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello"}}]}
Modifying only the CloudCustomData information of the message object
{"GroupId": "@TGS#1HYEP2SHC","MsgSeq": 23,"CloudCustomData": "your cloud custom data"}
Modifying both the MsgBody and CloudCustomData information of the message object
{"GroupId": "@TGS#1HYEP2SHC","MsgSeq": 23,"MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "hello"}}],"CloudCustomData": "your cloud custom data"}
Request fields
Field | Type | Required | Description |
GroupId | String | Yes | The ID of the Group whose historical messages will be modified |
MsgSeq | Integer | Yes | Sequence number of the message to be modified |
MsgBody | Array | No | Message body. For format details, see Message Formats. (Note: a message can contain multiple message elements, in which case MsgBody is an array.) |
CloudCustomData | String | No | Custom message data. It is saved in the cloud and will be sent to the receiver. Such data can be pulled after the app is uninstalled and reinstalled. |
TopicId | String | No | ID of the topic for which historical messages are modified. This field applies only to topic-enabled community groups. |
Sample response
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "succeed"}
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 |
20001 | Invalid request. |
20002 | UserSig or A2 has expired. |
20004 | Network exception. Try again. |
20005 | Internal server error. Try again. |
90001 | Failed to parse the JSON request. Make sure the format is valid. |
90002 | The MsgBody in the JSON request does not meet message format requirements or MsgBody is not an array. For more information, see the Message Element TIMMsgElement section in Message Formats. |
90003 | The JSON request does not contain the To_Account field or the To_Account field is not a string. |
90007 | The MsgBody field in the JSON request is not an array. Change it to an array. |
90009 | The request requires app admin permissions. |
90010 | The JSON request does not meet message format requirements. For more information, see the Message Element TIMMsgElement section in Message Formats. |
91000 | Internal service error. Try again. |
90992 | Internal service error. Try again. If this error code is returned for all requests and webhook is enabled, make sure the app server returns the results to the Chat backend normally. |
API Debugging Tool
References
Sending Ordinary Messages in a Group (v4/group_open_http_svc/send_group_msg)
Pulling Historical Messages (group_open_http_svc/group_msg_get_simple)
