Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "blacklist"

黑名单管理API,官方文档

Index

Functions

Const getblacklist

  • getblacklist(accessToken: string, begin_openid?: string): Promise<IGetBlackList | null>
  • 获取黑名单列表

    import {getblacklist} from 'ts-wxsdk/blacklist'
    const list = await getbalcklist(accessToken,'');

    Parameters

    • accessToken: string
    • Default value begin_openid: string = ""

      开始的openid,如果为空,从头开始,分页用

    Returns Promise<IGetBlackList | null>

Const setUser2Blacklist

  • setUser2Blacklist(accessToken: string, openid_list: Array<string>): Promise<null | IRes>
  • 把用户添加到黑名单列表

    Parameters

    • accessToken: string

      accessToken

    • openid_list: Array<string>

      openids

    Returns Promise<null | IRes>

Const unsetUser2Blacklist

  • unsetUser2Blacklist(accessToken: string, openid_list: Array<string>): Promise<null | IRes>
  • 取消设置为黑名单

    Parameters

    • accessToken: string

      accessToken

    • openid_list: Array<string>

      用户列表

    Returns Promise<null | IRes>

Generated using TypeDoc