即时通信

列入黑名单

POST

/im/v2/block_contacts

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

account_id

string

发起黑名单操作的云信账号 ID。

必需

contact_account_id

string

需要被列入黑名单的云信账号 ID。

必需

示例

{
  "account_id": "apifoxtest1",
  "contact_account_id": "apifoxtest2"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.yunxinapi.com/im/v2/block_contacts' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_id": "apifoxtest1",
    "contact_account_id": "apifoxtest2"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

状态码，200 表示请求成功。

msg

string

必需

提示信息。请求失败时返回错误信息，请求成功时返回 "success"。

data

object

必需

返回的 JSON 数据对象，请求失败则返回空对象。

示例

{
  "code": 0,
  "msg": "string",
  "data": {}
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-26 02:26:44

设置静音

移出黑名单