### Project Data Structure Example Source: https://openapi.weibanzhushou.com/api-/9024843 This snippet shows a typical data structure for a project entry in the OpenAPI Weibanzhushou API. It includes staff lists, start and end times, and status. The 'staff_list' is an array of strings representing staff names, and 'start_time' and 'update_at' are Unix timestamps. ```json { "staff_list": [ "DongSen", "FengKaiChang", "ZhouYu", "ZhangShunTao", "JiangRong" ], "start_time": 1622103360, "status": "finished", "update_at": 1622106102 } ``` -------------------------------- ### GET /open-api/tag/sync Source: https://openapi.weibanzhushou.com/api-/10010039 同步企业微信标签到微伴助手。此接口用于将企业微信中的标签数据同步到微伴助手平台。调用此接口需购买基础席位。 ```APIDOC ## GET /open-api/tag/sync ### Description 同步企业微信标签到微伴助手。调用此接口需购买基础席位。 ### Method GET ### Endpoint /open-api/tag/sync ### Base URL https://open.weibanzhushou.com ### Parameters #### Query Parameters - **access_token** (string) - Required - 调用接口凭证 ### Request Example ``` GET /open-api/tag/sync?access_token={{access_token}} ``` ### Response #### Success Response (200) - **errcode** (integer) - 错误码 - **errmsg** (string) - 错误信息 #### Response Example ```json { "errcode": 0, "errmsg": "ok" } ``` ### Tags 标签库管理 ### Status Released ``` -------------------------------- ### GET /open-api/activity_fission/mission/detail Source: https://openapi.weibanzhushou.com/api-/8932487 获取企微任务宝活动中指定任务的详细信息。该接口支持按任务完成状态、时间顺序进行筛选和排序，并支持分页查询。调用此接口需要购买营销席位。 ```APIDOC ## GET /open-api/activity_fission/mission/detail ### Description 获取企微任务宝任务详情。该接口用于查询营销活动中的任务信息，支持按完成状态筛选、按时间排序、分页查询等功能。 ### Method GET ### Endpoint /open-api/activity_fission/mission/detail ### Parameters #### Query Parameters - **main_mission_id** (string) - Required - 活动ID。示例值：63 - **finished** (string) - Optional - 任务是否完成。1表示任务已完成，0表示任务未完成。示例值：1 - **order** (string) - Optional - 排序方式。按照微伴系统收录任务时间升序或降序排列，可选值：asc(升序)、desc(降序)，默认值为asc。示例值：asc - **limit** (string) - Optional - 列表返回长度。默认值为30，最大值为100。示例值：31 - **offset** (string) - Optional - 列表偏移。用于迭代获取所有数据，默认值为0。示例值：0 - **access_token** (string) - Required - 调用接口凭证。默认值：{{access_token}} ### Request Example ``` curl --location -g --request GET 'https://open.weibanzhushou.com/open-api/activity_fission/mission/detail?main_mission_id=63&finished=1&order=asc&limit=31&offset=0&access_token=YOUR_ACCESS_TOKEN' ``` ### Response #### Success Response (200) - **mission_id** (string) - 任务ID - **main_mission_id** (string) - 活动ID - **finished** (integer) - 任务完成状态。1表示已完成，0表示未完成 - **created_at** (string) - 任务创建时间 - **updated_at** (string) - 任务更新时间 ### Error Codes | 错误码 | 说明 | |--------|------| | 21408 | corp_id 错误，找不到对应的企业 | | 21409 | main_session_id 不合法 | | 21410 | finished 不合法 | | 21411 | order 不合法 | | 21412 | limit 不合法 | | 21413 | offset 不合法 | ### Notes - 调用此接口需购买营销席位 - 支持通过 access_token 进行身份验证 - 默认按任务收录时间升序排列 - 最多可一次获取100条记录 ``` -------------------------------- ### Example Data Structure for Another QYWX Activity Source: https://openapi.weibanzhushou.com/api-/8930377 Another example of a 'qywx' activity data structure, showcasing variations in 'invited_count', 'name', 'notify_rule', and 'tags'. This highlights the dynamic nature of activity configurations within the API. ```json { "af_type": "qywx", "created_at": 1594194930, "id": 43, "invited_count": 2, "name": "测试任务宝", "new_user_count": 0, "outflow_count": 0, "prize_rule": [ { "finished_mark_tag": [], "level": 1, "notify_rule": 2, "prize_staff_id_list": null } ], "staff_ids": [ "YangGuang" ], "status": "end", "tags": [ 1125 ] } ``` -------------------------------- ### Custom Order Management - Get Product List Source: https://openapi.weibanzhushou.com/api-/index Retrieves a list of products. ```APIDOC ## GET /api/products ### Description Retrieves a list of products. ### Method GET ### Endpoint /api/products ### Parameters #### Query Parameters - **access_token** (string) - Required - The access token obtained via the token API. - **shop_id** (string) - Optional - Filter products by shop ID. - **limit** (integer) - Optional - The maximum number of products to return. - **offset** (integer) - Optional - The number of products to skip. ### Response #### Success Response (200) - **products** (array) - A list of product objects. - **product_id** (string) - The unique identifier for the product. - **product_name** (string) - The name of the product. - **price** (number) - The price of the product. - **shop_id** (string) - The ID of the shop the product belongs to. #### Response Example ```json { "errcode": 0, "errmsg": "ok", "products": [ { "product_id": "PROD501", "product_name": "Laptop", "price": 1200.00, "shop_id": "SHOP001" }, { "product_id": "PROD502", "product_name": "T-Shirt", "price": 25.50, "shop_id": "SHOP002" } ] } ``` ``` -------------------------------- ### Example QYWX Activity with Different Notification Rule Source: https://openapi.weibanzhushou.com/api-/8930377 This JSON example demonstrates a 'qywx' activity with 'notify_rule' set to 20. It also includes multiple 'staff_ids', 'LuoDaDa' and 'YiShiYuQiao', and a comprehensive set of tags, suggesting a complex or highly configured activity. ```json { "af_type": "qywx", "created_at": 1594608217, "id": 50, "invited_count": 0, "name": "ssss", "new_user_count": 0, "outflow_count": 0, "prize_rule": [ { "finished_mark_tag": [], "level": 1, "notify_rule": 20, "prize_staff_id_list": null } ], "staff_ids": [ "LuoDaDa", "YiShiYuQiao" ], "status": "end", "tags": [ 973, 974, 1013, 1021 ] } ``` -------------------------------- ### POST /open-api/customer_open_sea/clue/add Source: https://openapi.weibanzhushou.com/api-/9026517 Adds new customer clues to the system. This endpoint allows for detailed information including base info, custom info, and assignment to staff. ```APIDOC ## POST /open-api/customer_open_sea/clue/add ### Description This endpoint allows you to add new customer clues to the system. You can provide detailed information such as phone number, staff ID, remarks, grade, tags, base information, and custom information. ### Method POST ### Endpoint `/open-api/customer_open_sea/clue/add` ### Parameters #### Query Parameters - **access_token** (string) - Required - The access token for calling the API. #### Request Body - **clue_list** (array[object]) - Required - A list of clue objects to be added. - **phone** (string) - Optional - The phone number of the clue. Must be 11 digits. - **staff_ext_id** (string) - Optional - The ID of the staff member the clue is assigned to. - **remark** (string) - Optional - Remarks for the customer clue. - **batch_add_customer_mission** (boolean) - Optional - Whether to send a batch task to the staff for adding friends. Defaults to true. - **grade_id** (integer) - Optional - The grade ID of the clue. Defaults to 0. - **tags** (array[string]) - Optional - A list of tags for the clue. - **base_info** (object) - Optional - Basic information about the clue. - **state** (string) - The source of the clue. - **description** (string) - A description of the clue. - **age** (string) - The age of the contact. - **phone_number** (string) - The phone number. - **qq** (string) - The QQ number. - **weibo** (string) - The Weibo profile. - **email** (string) - The email address. - **address** (string) - The address. - **birthday** (string) - The birthday. - **custom_info** (object) - Optional - Custom information for the clue. Must include `field_name` when provided. - **field_name** (string) - The name of the custom field. - **field_value** (string) - The value of the custom field. ### Request Example ```json { "clue_list": [ { "phone": "13367278448", "staff_ext_id": "ZengDeWei", "remark": "大头", "batch_add_customer_mission": true, "grade_id": 0, "tags": [], "base_info": { "state": "来源", "description": "描述", "age": "年龄", "phone_number": "电话", "qq": "QQ", "weibo": "微博", "email": "邮箱", "address": "地址", "birthday": "生日" }, "custom_info": { "field_name": "文本字段", "field_value": "184cm" } } ] } ``` ### Response #### Success Response (200) - **errcode** (integer) - Error code, 0 for success. - **errmsg** (string) - Error message, "ok" for success. #### Response Example ```json { "errcode": 0, "errmsg": "ok" } ``` ``` -------------------------------- ### Example QYWX Activity with Multiple Tags Source: https://openapi.weibanzhushou.com/api-/8930377 This JSON snippet illustrates a 'qywx' activity configuration that includes multiple tags (974, 1021). It also shows an example where 'staff_ids' contains multiple entries, indicating potential team assignments for the activity. ```json { "af_type": "qywx", "created_at": 1594388842, "id": 45, "invited_count": 0, "name": "测试任务宝", "new_user_count": 0, "outflow_count": 0, "prize_rule": [ { "finished_mark_tag": [], "level": 1, "notify_rule": 2, "prize_staff_id_list": null } ], "staff_ids": [ "clth" ], "status": "end", "tags": [ 974, 1021 ] } ``` -------------------------------- ### GET获取拉新排行榜活动列表接口调用 Source: https://openapi.weibanzhushou.com/api-/9024843 调用微伴助手OpenAPI获取拉新排行榜活动列表。通过limit参数控制返回列表长度（默认30，最大100），通过offset参数实现分页迭代获取所有数据（默认0）。需提供access_token作为调用凭证，调用此接口需购买营销席位。 ```Shell curl --location -g --request GET 'https://open.weibanzhushou.com/open-api/staff_rank/list?limit=10&offset=0&access_token=' ``` -------------------------------- ### Add Clue Request Example (cURL) Source: https://openapi.weibanzhushou.com/api-/9026517 This cURL command demonstrates how to send a POST request to the Weibanzhushou API to add a customer clue. It includes the access token, content type, and the JSON payload with clue details. ```shell curl --location -g --request POST 'https://open.weibanzhushou.com/open-api/customer_open_sea/clue/add?access_token=' \ --header 'Content-Type: application/json' \ --data-raw '{ "clue_list":[ { "phone":"13367278448", "staff_ext_id":"ZengDeWei", "remark":"大头", "batch_add_customer_mission":true, "grade_id":0, "tags": [], "base_info":{ "state": "来源", "description": "描述", "age": "年龄", "phone_number": "电话", "qq": "QQ", "weibo": "微博", "email": "邮箱", "address": "地址", "birthday": "生日" }, "custom_info":{ "field_name":"文本字段", "field_value":"184cm" } } ] }' ``` -------------------------------- ### GET /open-api/staff_sop/one/rule/list Source: https://openapi.weibanzhushou.com/api-/135169849 Retrieves a list of rules for a specific individual SOP. This endpoint requires purchasing a marketing seat to use. It allows filtering by SOP ID, start time, and end time. ```APIDOC ## GET /open-api/staff_sop/one/rule/list ### Description Retrieves a list of rules for a specific individual SOP. This endpoint requires purchasing a marketing seat to use. It allows filtering by SOP ID, start time, and end time. ### Method GET ### Endpoint /open-api/staff_sop/one/rule/list ### Parameters #### Query Parameters - **staff_sop_id** (integer) - Required - The ID of the staff SOP to retrieve rules for. - **start_time** (integer) - Optional - The start timestamp for filtering rules. - **end_time** (integer) - Optional - The end timestamp for filtering rules. - **access_token** (string) - Required - The access token for calling the API. ### Request Example ```json { "staff_sop_id": 3000126150, "start_time": 1626192000, "end_time": 1626194000, "access_token": "{{access_token}}" } ``` ### Response #### Success Response (200) - **errcode** (integer) - Error code. - **errmsg** (string) - Error message. - **result** (array) - An array of SOP rule objects. - **id** (integer) - The rule ID within the individual SOP. - **time_type** (string) - The time type from the operational strategy. - **rule_name** (string) - The name of the rule within the individual SOP. - **add_time** (integer) - The duration in the operational strategy before triggering. - **next_day** (integer) - The day of the week for triggering in the operational strategy. - **next_time** (integer) - The time of day for triggering in the operational strategy. - **point_time** (string) - The scheduled push time. - **messages** (array) - An array of message objects. - **msg_type** (string) - The type of message (e.g., 'link', 'miniprogram', 'file', 'image', 'video', 'radar_link', 'normal_link', 'form_link', 'lottery_link'). - **msg_content** (string) - The content of the text message. - **radar** (object) - Radar-specific details. - **activity_notify** (boolean) - **advanced_setup_enable** (boolean) - **auto_mark_tag** (array of strings) - **auto_mark_tag_rule** (array of strings) - **auto_mark_tag_object** (null) - **auto_add_integral_rule** (null) - **behavior_notify** (boolean) - **cover_url** (string) - **desc** (string) - **has_tag** (boolean) - **id** (integer) - **hash_id** (string) - **is_usual** (boolean) - **link** (string) - **name** (string) - **score_rule** (object) #### Response Example ```json { "errcode": 0, "errmsg": "OK", "result": [ { "id": 1, "time_type": "", "rule_name": "Rule 1", "add_time": 3600, "next_day": 1, "next_time": 9, "point_time": "2023-01-01 10:00:00", "messages": [ { "msg_type": "link", "msg_content": "Check this out!", "radar": { "activity_notify": false, "advanced_setup_enable": false, "auto_mark_tag": [], "auto_mark_tag_rule": [], "auto_mark_tag_object": null, "auto_add_integral_rule": null, "behavior_notify": false, "cover_url": "", "desc": "", "has_tag": false, "id": 0, "hash_id": "", "is_usual": false, "link": "https://example.com", "name": "Radar Name", "score_rule": {} } } ] } ] } ``` ``` -------------------------------- ### Get Store List - OpenAPI Specification (YAML) Source: https://openapi.weibanzhushou.com/api-/81972694 This YAML snippet defines the OpenAPI 3.0.1 specification for the '/open-api/contact_way/store/list' GET endpoint. It details the available query parameters such as page size, page number, staff ID, region name, deletion status, and access token. The response schema for a successful request (200 OK) is also defined, including an example JSON payload. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /open-api/contact_way/store/list: get: summary: 门店列表 deprecated: false description: | 门店列表 调用此接口需购买营销席位。 tags: - 门店信息 parameters: - name: page_size in: query description: '' required: false example: 20 schema: type: integer - name: page_no in: query description: '' required: false example: 1 schema: type: integer - name: staff_ext_id in: query description: 门店店主 required: false example: '' schema: type: string - name: region_name in: query description: 门店名称 required: false example: '' schema: type: string - name: deleted in: query description: 是否删除(delete=0,筛选未删除数据) required: false example: '' schema: type: string - name: access_token in: query description: 调用接口凭证 required: true example: '{{access_token}}' schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: 01H0H594EJTAAFK0E1XYD22V3F: type: string x-apifox-orders: - 01H0H594EJTAAFK0E1XYD22V3F required: - 01H0H594EJTAAFK0E1XYD22V3F example: | { "data": { "has_next": true, "objects": [ { "address": "北京市东城区故宫博物院", "city": "北京市", "clerk_staff_ext_id_list": [], "clerk_staff_objs": [], "corp_id": "1703429757388935169", "country": "中国", "created_at": 1673007003, "creator_id": 3073, "creator_info": { "address": "", "alias": "", "avatar": "https://wework.qpic.cn/wwpic/710153_4_JlQCW-QaivNs3_1683771279/0", "corp_id": "1703429757388935169", "created_at": 1624533184, "email": "", "enable": true, "english_name": "", "ext_id": "WangBaoJun", "extattr":"{\"attrs\": [{\"name\": \"\u4e13\u4e1a\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}, {\"name\": \"\u5b66\u53f7\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}, {\"name\": \"\u5b66\u9662\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}, {\"name\": \"\u73ed\u7ea7\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}, {\"name\": \"\u751f\u65e5\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}, {\"name\": \"\u7c4b\u8d2f\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}, {\"name\": \"\u82f1\u6587\u540d\", \"value\": \"\", \"type\": 0, \"text\": {\"value\": \"\"}}]}", "external_contact_able": true, "external_position": null, "external_profile": "{\"external_attr\": [], \"external_corp_name\": \"\"}", "external_user_count": 0, "gender": 2, "ia_authorized": true, "ia_authorized_at": 1683871498, "ia_ext_id": "WangBaoJun", "id": 3073, "is_root": false, "ma_authorized": true, "ma_authorized_at": 1656914914, "mobile": "18940575136", "moment_address": null, "moment_cover": null, "name": "王保军-点石超长名字-点石超长名字-点石超长名字-点石超长名字", "new_ext_id": null, "oa_authorized": true, "oa_authorized_at": 1634216416, "oa_ext_id": "wogizUDQAAdea353O0PwqGHgdPvzjWwQ", "openid": null ``` -------------------------------- ### GET /open-api/group_msg/result Source: https://openapi.weibanzhushou.com/api-/124355776 Retrieves a paginated list of group message broadcast tasks with detailed information about delivery status, message content, and statistics. This endpoint requires a valid access token and basic seat subscription. The query supports time-based filtering with a maximum 3-day range between start and end times. ```APIDOC ## GET /open-api/group_msg/result ### Description Retrieve group message broadcast task results with pagination and time-based filtering. Provides detailed information about each broadcast mission including delivery statistics, message content, and staff information. ### Method GET ### Endpoint /open-api/group_msg/result ### Parameters #### Query Parameters - **limit** (integer) - Optional - Number of results per page, maximum value 30 (default: 20) - **offset** (integer) - Optional - Pagination offset for results (default: 0) - **start_time** (integer) - Required - Filter start time as Unix timestamp. Filters by message send time in WeiBan backend - **end_time** (integer) - Required - Filter end time as Unix timestamp. Filters by message send time in WeiBan backend. Note: end_time and start_time cannot differ by more than 3 days - **access_token** (string) - Required - API access token for authentication ### Request Example ``` GET /open-api/group_msg/result?limit=20&offset=0&start_time=1609459200&end_time=1609545600&access_token=YOUR_ACCESS_TOKEN ``` ### Response #### Success Response (200 OK) Returns an object containing: - **errcode** (integer) - Error code (0 for success) - **errmsg** (string) - Error message - **missions** (array) - Array of broadcast mission objects #### Mission Object Properties - **id** (integer) - Broadcast mission ID - **name** (string) - Broadcast mission name - **created_at** (string) - Creation timestamp - **send_at** (string) - Scheduled send time - **status** (string) - Delivery status - **send_type** (string) - Type of broadcast (e.g., customer, staff) - **staff_ext_id** (string) - Creator staff external ID - **staff_name** (string) - Creator staff name - **staff_id_count** (integer) - Total number of staff in broadcast - **staff_id_list** (array) - List of staff external IDs included in broadcast - **sended_staff_count** (integer) - Number of staff who have received the message - **not_send_staff_count** (integer) - Number of staff who have not received the message - **send_eu_count** (integer) - Number of customers who received the message - **not_send_eu_count** (integer) - Number of customers who did not receive the message - **msg_data** (object) - Message content object containing text and attachments - **text** (object) - Text message content - **content** (string) - Text message body - **attachments** (array) - Array of attachment objects - **sub_mission_list** (array) - Array of sub-mission objects with delivery details - **staff_ext_id** (string) - Staff external ID for this sub-mission - **external_user_list** (array) - List of customer IDs for this sub-mission - **status** (string) - Delivery status for this sub-mission #### Response Example ```json { "errcode": 0, "errmsg": "ok", "missions": [ { "id": 123456, "name": "Q4 Promotional Campaign", "created_at": "2021-01-01T10:00:00Z", "send_at": "2021-01-02T10:00:00Z", "status": "completed", "send_type": "customer", "staff_ext_id": "zhangsan", "staff_name": "Zhang San", "staff_id_count": 5, "staff_id_list": ["staff1", "staff2", "staff3", "staff4", "staff5"], "sended_staff_count": 5, "not_send_staff_count": 0, "send_eu_count": 450, "not_send_eu_count": 50, "msg_data": { "text": { "content": "Dear valued customer, enjoy our Q4 promotion!" }, "attachments": [] }, "sub_mission_list": [ { "staff_ext_id": "zhangsan", "external_user_list": ["customer1", "customer2", "customer3"], "status": "completed" } ] } ] } ``` ### Notes - Requires basic seat subscription to use this API - Time range between start_time and end_time cannot exceed 3 days - Maximum 30 results per page - All timestamps should be in Unix timestamp format (seconds since epoch) ``` -------------------------------- ### Custom Order Management - Get Product Information Details Source: https://openapi.weibanzhushou.com/api-/index Retrieves detailed information for a specific product. ```APIDOC ## POST /api/products/details ### Description Retrieves detailed information for a specific product. ### Method POST ### Endpoint /api/products/details ### Parameters #### Query Parameters - **access_token** (string) - Required - The access token obtained via the token API. #### Request Body - **product_id** (string) - Required - The ID of the product to retrieve details for. ### Request Example ```json { "product_id": "PROD501" } ``` ### Response #### Success Response (200) - **product_id** (string) - The unique identifier for the product. - **product_name** (string) - The name of the product. - **description** (string) - The description of the product. - **price** (number) - The price of the product. - **stock_quantity** (integer) - The current stock quantity. - **shop_id** (string) - The ID of the shop the product belongs to. #### Response Example ```json { "errcode": 0, "errmsg": "ok", "product_id": "PROD501", "product_name": "Laptop", "description": "High-performance laptop with 16GB RAM.", "price": 1200.00, "stock_quantity": 50, "shop_id": "SHOP001" } ``` ``` -------------------------------- ### Example QYWX Activity with Specific Tags and Staff Source: https://openapi.weibanzhushou.com/api-/8930377 This JSON object represents a 'qywx' activity with specific tags (1021, 1016) and assigned staff ('LuoKai'). The 'invited_count' is 2, suggesting some user engagement for this particular activity. ```json { "af_type": "qywx", "created_at": 1594640081, "id": 56, "invited_count": 2, "name": "反反复复付", "new_user_count": 0, "outflow_count": 0, "prize_rule": [ { "finished_mark_tag": [], "level": 1, "notify_rule": 12, "prize_staff_id_list": null } ], "staff_ids": [ "LuoKai" ], "status": "end", "tags": [ 1021, 1016 ] } ``` -------------------------------- ### Custom Order Management - Batch Sync Product Information Source: https://openapi.weibanzhushou.com/api-/index Performs a batch synchronization of product information. ```APIDOC ## POST /api/products/sync/batch ### Description Performs a batch synchronization of product information into the system. ### Method POST ### Endpoint /api/products/sync/batch ### Parameters #### Query Parameters - **access_token** (string) - Required - The access token obtained via the token API. #### Request Body - **products** (array) - Required - A list of product objects to synchronize. - **product_id** (string) - Required - The unique identifier for the product. - **product_name** (string) - Required - The name of the product. - **price** (number) - Required - The price of the product. - **shop_id** (string) - Required - The ID of the shop the product belongs to. ### Request Example ```json { "products": [ { "product_id": "PROD501", "product_name": "Laptop", "price": 1200.00, "shop_id": "SHOP001" }, { "product_id": "PROD502", "product_name": "T-Shirt", "price": 25.50, "shop_id": "SHOP002" } ] } ``` ### Response #### Success Response (200) - **success_count** (integer) - The number of products successfully synchronized. - **failed_count** (integer) - The number of products that failed to synchronize. - **failed_details** (array) - A list of details for failed synchronizations (if any). #### Response Example ```json { "errcode": 0, "errmsg": "ok", "success_count": 2, "failed_count": 0, "failed_details": [] } ``` ``` -------------------------------- ### OpenAPI GET endpoint - Lock Customer QR Code State Info Source: https://openapi.weibanzhushou.com/api-/334197668 GET endpoint that retrieves lock customer QR code detailed information using a state parameter. Requires state query parameter (example: wb:5:110659954) and optional access_token. Returns comprehensive channel analytics including access counts, addition counts, and tag information, along with QR code metadata such as creation time, creator name, and group identifiers. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /open-api/contact_way/lock_customer/state_info: get: summary: 锁客二维码通过state获取详细信息 deprecated: false description: '' tags: - 锁客二维码 parameters: - name: state in: query description: 锁客二维码员工码的state required: true example: wb:5:110659954 schema: type: string - name: access_token in: query description: '' required: false example: 445a72016759331b650e7ab471f0dc0c/contact_way/lock_customer/state_info schema: type: string ``` -------------------------------- ### Custom Order Management - Get Shop List Source: https://openapi.weibanzhushou.com/api-/index Retrieves a list of shops. ```APIDOC ## GET /api/shops ### Description Retrieves a list of shops. ### Method GET ### Endpoint /api/shops ### Parameters #### Query Parameters - **access_token** (string) - Required - The access token obtained via the token API. - **limit** (integer) - Optional - The maximum number of shops to return. - **offset** (integer) - Optional - The number of shops to skip. ### Response #### Success Response (200) - **shops** (array) - A list of shop objects. - **shop_id** (string) - The unique identifier for the shop. - **shop_name** (string) - The name of the shop. - **location** (string) - The location of the shop. #### Response Example ```json { "errcode": 0, "errmsg": "ok", "shops": [ { "shop_id": "SHOP001", "shop_name": "Tech Gadgets", "location": "Downtown" }, { "shop_id": "SHOP002", "shop_name": "Fashion Hub", "location": "Mall Area" } ] } ``` ``` -------------------------------- ### Example Data Structure for QYWX Activity Source: https://openapi.weibanzhushou.com/api-/8930377 This JSON object represents the structure of an activity of type 'qywx' (likely referring to a specific platform or service like WeChat Work). It includes details like creation timestamp, unique ID, invitation counts, name, user counts, outflow metrics, prize rules, assigned staff, status, and associated tags. ```json { "af_type": "qywx", "created_at": 1593609566, "id": 41, "invited_count": 0, "name": "明白", "new_user_count": 0, "outflow_count": 0, "prize_rule": [ { "finished_mark_tag": [], "level": 1, "notify_rule": 1, "prize_staff_id_list": null } ], "staff_ids": [ "YangGuang" ], "status": "end", "tags": [ 973 ] } ``` -------------------------------- ### POST /open-api/external_user_package/list Source: https://openapi.weibanzhushou.com/api-/64661589 Retrieves a list of created user packages. This endpoint requires a purchased basic seat. ```APIDOC ## POST /open-api/external_user_package/list ### Description Retrieves a list of created user packages. This endpoint requires a purchased basic seat. ### Method POST ### Endpoint /open-api/external_user_package/list ### Parameters #### Query Parameters - **access_token** (string) - Required - Call interface credentials #### Request Body - **name** (string) - Optional - Name of the user package - **staff_id_list** (integer array) - Optional - List of staff primary IDs - **page_no** (integer) - Required - Page number - **page_size** (integer) - Required - Number of items per page ### Request Example ```json { "name": "Example Package Name", "staff_id_list": [1, 2, 3], "page_no": 1, "page_size": 10 } ``` ### Response #### Success Response (200) - **data_list** (object array) - List of user packages - **creator_name** (string) - Name of the creator - **data_update_time** (string) - Update time - **description** (string) - Description of the user package - **name** (string) - Name of the user package - **update_type** (string) - Update type ('auto' for automatic, 'manual' for manual) - **user_count** (integer) - Current number of users - **filter_type** (string) - Trigger type ('all' for all customers, 'filter' for filtered, 'import' for imported, 'openApi' for API imported) - **id** (integer) - User package ID - **status_code** (integer) - Status code of the response - **status_message** (string) - Message describing the status - **success** (boolean) - Indicates if the operation was successful - **total_count** (integer) - Total number of user packages available #### Response Example ```json { "data_list": [ { "creator_name": "", "data_update_time": "2023-02-24 14:48:14", "description": "Description xxx", "name": "Open Package One", "update_type": "auto", "user_count": 1, "filter_type": "all", "id": 123 } ], "status_code": 0, "status_message": "Success", "success": true, "total_count": 10 } ``` ``` -------------------------------- ### POST /open-api/external_user_package/add Source: https://openapi.weibanzhushou.com/api-/64661822 Creates an audience package with provided user information. This endpoint requires purchasing a basic seat. At least one of phone list, unionid list, or customer ID list must be provided. ```APIDOC ## POST /open-api/external_user_package/add ### Description Creates an audience package with provided user information. This endpoint requires purchasing a basic seat. At least one of phone list, unionid list, or customer ID list must be provided. ### Method POST ### Endpoint /open-api/external_user_package/add ### Parameters #### Query Parameters - **access_token** (string) - Required - The access token required to call the API. #### Request Body - **name** (string) - Required - The name of the audience package. - **description** (string) - Optional - A description for the audience package. - **staff_id** (string) - Required - The ID of the staff member creating the package. - **phone_list** (array of integers) - Optional - A list of customer phone numbers. Example: `[18571111234, 1531111234]` - **unionid_list** (array of strings) - Optional - A list of customer union IDs. Example: `["corresponding_unionid", "corresponding_unionid2"]` - **external_user_ext_id_list** (array of strings) - Optional - A list of customer IDs. Example: `["wmeo9iCwAA6jDXWsMIjt-zaST7zI0GNQ"]` - **unionid_openid_list** (array of objects) - Required - A list of objects, each containing `openid` (string) and `unionid` (string). - **openid** (string) - Required - The openid of the customer. - **unionid** (string) - Required - The unionid of the customer. ### Request Example ```json { "name": "Example Package", "description": "A sample audience package", "staff_id": "staff123", "phone_list": [ 18571111234, 1531111234 ], "unionid_list": [ "unionid1", "unionid2" ], "external_user_ext_id_list": [ "extid1", "extid2" ], "unionid_openid_list": [ { "openid": "openid1", "unionid": "unionid1" }, { "openid": "openid2", "unionid": "unionid2" } ] } ``` ### Response #### Success Response (200) - **errcode** (integer) - Error code (0 for success). - **errmsg** (string) - Error message ('ok' for success). - **package_id** (integer) - The ID of the created audience package. #### Response Example ```json { "errcode": 0, "errmsg": "ok", "package_id": 429 } ``` ``` -------------------------------- ### GET /open-api/group_chat/list Source: https://openapi.weibanzhushou.com/api-/8278618 Retrieve a list of group chats. You can filter by staff_id to get group chats for a specific employee. This endpoint requires a basic seat license to use. ```APIDOC ## GET /open-api/group_chat/list ### Description Retrieves a paginated list of group chats. Can filter by employee (staff_id) to return only that employee's group chats. ### Method GET ### Endpoint /open-api/group_chat/list ### Parameters #### Query Parameters - **staff_id** (string) - Optional - Enterprise WeChat employee ID. If provided, returns only group chats associated with this employee - Example: "Shiyan" - **limit** (string) - Optional - Number of records to return per page. Default: 30, Maximum: 100 - Example: "10" - **offset** (string) - Optional - Pagination offset for iterating through all data. Default: 0 - Example: "0" - **access_token** (string) - Required - API access token for authentication - Example: "{{access_token}}" ### Request Example ``` curl --location -g --request GET 'https://open.weibanzhushou.com/open-api/group_chat/list?staff_id=Shiyan&limit=10&offset=0&access_token=YOUR_ACCESS_TOKEN' ``` ### Response #### Success Response (200) Returns a paginated list of group chat objects containing: - **group_id** (string) - Unique identifier for the group chat - **group_name** (string) - Name of the group chat - **staff_id** (string) - ID of the employee managing the group - **member_count** (integer) - Number of members in the group - **create_time** (timestamp) - Group creation timestamp ### Notes - Requires purchase of basic seat license - Maximum limit is 100 records per request - Use offset parameter for pagination through large datasets ```