Skip to main content

Add Blacklist

Brief Description

  • Add blackUserID to ownerUserID's blacklist, blackUserID can no longer send messages to ownerUserID.

Request Method

  • post

Request URL

  • {API_ADDRESS}/friend/add_black
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"ownerUserID": "11111111",
"blackUserID": "11111113",
"ex": "ex"
}
Field NameOptionalTypeDescription
ownerUserIDRequiredstringAdd blacklist to this user
blackUserIDRequiredstringBlocked user ID
exOptionalstringExtension field

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means success
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty

Failure Return Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, see global error code document for details
errMsgstringBrief error message
errDlterrDltDetailed error message