add_black
Description
- Add
blackUserID
to the blacklist ofownerUserID
, preventingblackUserID
from sending messages toownerUserID
.
Request Method
post
Request URL
{API_ADDRESS}/friend/add_black
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | Used for global traceability, recommended to use a timestamp for uniqueness in each request. |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Body Example
{
"ownerUserID": "11111111",
"blackUserID": "11111113",
"ex": "ex"
}
Field Name | Optional | Type | Description |
---|---|---|---|
ownerUserID | Required | string | The user adding to blacklist |
blackUserID | Required | string | The user being blacklisted |
ex | Optional | string | Extension field |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Success Response Parameters
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 means success |
errMsg | string | Brief error message, empty if successful |
errDlt | string | Detailed error information, empty if successful |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameters
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to the global error code documentation |
errMsg | string | Brief error message |
errDlt | string | Detailed error message |