即时通信

分页查询黑名单列表

GET

/im/v2/block_contacts

请求参数

Query 参数

account_id

string

必需

发起分页查询操作的云信账号 ID。

示例值:

apifoxtest1

page_token

string

可选

分页标识符（标识查询位置索引的字符串值），如果为空，则默认从第一条记录开始查询。

说明：对应上次分页查询返回的 next_token 值。

limit

string

可选

单页查询的数量上限，默认和最大值都为 100。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://open.yunxinapi.com/im/v2/block_contacts?account_id=apifoxtest1&page_token&limit' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

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

msg

string

必需

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

data

object

必需

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

has_more

boolean

可选

是否还有更多数据。

next_token

string

分页标识符。

可选

items

array[string]

可选

返回的黑名单账号信息。

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "has_more": true,
    "next_token": "string",
    "items": [
      "string"
    ]
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

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

移出黑名单

发送消息