Sign in
WeChat Official Accounts

Search Suggestions

Retrieves WeChat search suggestions for a keyword, optionally scoped by a supported business type. Use it to expand or refine a query before a targeted WeChat search.

get/api/weixin/search-suggestions/v1

Query parameters

tokenstring required

Access token for this API service.

keywordstring required

Keyword used to fetch WeChat search suggestions.

businessType'ALL' | 'ACCOUNT' | 'ARTICLE' | 'CHANNEL' | 'MOMENTS' | 'LIVE' | 'EMOJI' | 'AUDIO' | 'BOOK' | 'WECHAT_INDEX' | 'NEWS' | 'MINI_PROGRAM' | 'ENCYCLOPEDIA'

Weixin search business type

WeChat search business type used to scope suggestion results.

Available Values:

  • ALL: All
  • ACCOUNT: Official accounts
  • ARTICLE: Articles
  • CHANNEL: Channels
  • MOMENTS: Moments
  • LIVE: Live
  • EMOJI: Emoji
  • AUDIO: Audio
  • BOOK: Books
  • WECHAT_INDEX: WeChat index
  • NEWS: News
  • MINI_PROGRAM: Mini programs
  • ENCYCLOPEDIA: Encyclopedia

Response

OK

code0 | 100 | 101 | 202 | 300 | 301 | 302 | 303 | 400 | 404 | 500 | 503 | 600 | 601 | 602 required
messagestring nullable required
{"stackTrail":"paths:/api/weixin/search-suggestions/v1:get:responses:200:content:application/json:schema:properties:data","oasType":"schema","type":"unknown"}
recordTimestring nullable required
requestIdstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.