https://xxxxxx/v4/official_account_open_http_svc/official_account_msg_recall?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | The dedicated domain for the country/region where your SDKAppID is located: 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/official_account_msg_recall | 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 fixed value: json |
{"Official_Account": "@TOA#_2J4SZEAEL","MsgKeyList":["71_1_1698741698","72_1_1698741698"],"Reason":"Revocation Reason"}
Field | Type | Attribute | Description |
Official_Account | String | Mandatory | Operated Official Account User ID |
MsgKeyList | Array | Mandatory | List of MsgKeys for messages being recalled, a single request can recall up to 10 messages |
Reason | String | Optional | Reason for message recall, length restricted to a maximum of 100 bytes |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RecallRetList":[{"MsgKey":"71_1_1698741698","RetCode":10030},{"MsgKey":"72_1_1698741699","RetCode":0}]}
Field | Type | Description |
ActionStatus | String | Processed Request Result: OK: Indicates successful processing FAIL: Indicates failure |
ErrorCode | Integer | Error Identifier: 0: Indicates success Non-zero: Indicates failure |
ErrorInfo | String | Error message |
RecallRetList | Array | Detailed results of the message recall request |
MsgKey | String | MsgKey of a single message being recalled |
RetCode | Integer | Recall result of a single message: 0 means success; other values mean failure, refer to the error code explanations below |
Error code | Description |
10002 | Internal server error, please try again |
10003 | Illegal Request Command Word |
10004 | Invalid parameter, please check if the request is correct based on the error description |
10007 | Insufficient operational permissions |
10010 | Official Account User does not exist, or may have existed in the past, but is now dissolved |
10015 | Invalid Official Account User ID, please check if the Official Account User ID is correctly filled in |
10030 | The message requested for recall does not exist |
10031 | The message requested for recall exceeds the time limit |
10032 | The message requested for recall does not support recall operations |
Was this page helpful?