Mini Program
取消
Development
中文
EN
取消
  • Server Side

    • # nearbyPoi.setShowStatus

    Call this API at the server side. For more information, see Server API.

    This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

    Displays/Cancels displaying Mini Programs Nearby.

    Calling methods:

    # HTTPS Call

    # Request Address

    POST https://api.weixin.qq.com/wxa/setnearbypoishowstatus?access_token=ACCESS_TOKEN

    # Request Parameters

    Attribute Type Default Required Description
    access_token string Yes Credentials to call API
    poi_id string Yes The ID of the location nearby.
    status number Yes Specifies whether to display Mini Programs Nearby.

    Valid values of status

    Value Description Minimum Version
    0 Not display
    1 Display

    # Return Value

    # Object

    Returned JSON data

    Property Type Description
    errmsg string Error message
    errcode number Error code

    # Errors

    Error Code Error Message Description
    0 ok Normal
    47001 Incorrect JSON format of POST data.
    20002 Invalid POST parameter.
    44002 POST data is empty.
    92000 The business qualification has been added. Do not repeatedly add it.
    92002 Unable to add more locations. The number of locations nearby has reached the upper limit.
    92003 The location has been occupied by another Mini Program.
    92004 The nearby feature has been banned.
    92005 The location is under review.
    92006 The Mini Program is being displayed at the location.
    92007 The location is rejected.
    92008 The Mini Program is not displayed at the location.
    93009 The Mini Program is not released or is invisible.
    93010 The location does not exist.
    93011 Personal Mini Programs are not supported.
    93011 Personal Mini Programs are not supported.
    93012 Non-common Mini Programs (for example, Mini Programs of stores and Mini Programs of WeChat shops) are not supported.
    93013 Failed to obtain address details from Tencent Map.
    93014 This qualification document ID is repeatedly added.

    # Cloud Call

    Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

    # API Calling Method

    openapi.nearbyPoi.setShowStatus

    You need to configure the permissions for the nearbyPoi.setShowStatus API via config.json. Details

    # Request Parameters

    Attribute Type Default Required Description
    poiId string Yes The ID of the location nearby.
    status number Yes Specifies whether to display Mini Programs Nearby.

    Valid values of status

    Value Description Minimum Version
    0 Not display
    1 Display

    # Return Value

    # Object

    Returned JSON data

    Property Type Description
    errMsg string Error message
    errCode number Error code

    # Exceptions

    # Object

    Thrown Exceptions

    Property Type Description
    errMsg string Error message
    errCode number Error code

    Valid values of errCode

    Value Description Minimum Version

    # Errors

    Error Code Error Message Description
    0 ok Normal
    47001 Incorrect JSON format of POST data.
    20002 Invalid POST parameter.
    44002 POST data is empty.
    92000 The business qualification has been added. Do not repeatedly add it.
    92002 Unable to add more locations. The number of locations nearby has reached the upper limit.
    92003 The location has been occupied by another Mini Program.
    92004 The nearby feature has been banned.
    92005 The location is under review.
    92006 The Mini Program is being displayed at the location.
    92007 The location is rejected.
    92008 The Mini Program is not displayed at the location.
    93009 The Mini Program is not released or is invisible.
    93010 The location does not exist.
    93011 Personal Mini Programs are not supported.
    93011 Personal Mini Programs are not supported.
    93012 Non-common Mini Programs (for example, Mini Programs of stores and Mini Programs of WeChat shops) are not supported.
    93013 Failed to obtain address details from Tencent Map.
    93014 This qualification document ID is repeatedly added.