API开放平台

TIP

新增修改bC活动
bC活动报名回调接口
查询bc活动

# 新增修改bC活动

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bcwin/v1/addOrUpdateCampaign/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "source_code": "6675329105525724449",
    "code": "BC20240101",
    "name": "BC20240101",
    "type_code": "",
    "event_status": "1",
    "start_date": "2024-01-01",
    "end_date": "2024-01-31",
    "register_url": "",
    "event_information": ""
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
source_code	VARCHAR(100)	是	第三方活动唯一标识。修改时通过此唯一标识匹配
code	VARCHAR(100)	是	活动编号
name	VARCHAR(100)	是	活动名称
type_code	VARCHAR(100)	是	活动类型编码
event_status	VARCHAR(100)	是	活动状态。1：已上线，2：中止，3：结束
start_date	VARCHAR(32)	是	活动开始日期。格式：yyyy-mm-dd
end_date	VARCHAR(32)	是	活动结束日期。格式：yyyy-mm-dd
register_url	VARCHAR(100)	是	活动报名URL
event_information	TEXT	是	活动信息
dept_id	VARCHAR(100)	否	归属部门ID，多个值以“,”分隔。dept_id、dept_code、dept_name、dept_source_code如果同时存在，优先级依次降低
dept_code	VARCHAR(100)	否	归属部门编码，多个值以“,”分隔。dept_id、dept_code、dept_name、dept_source_code如果同时存在，优先级依次降低
dept_name	VARCHAR(100)	否	归属部门名称，多个值以“,”分隔。dept_id、dept_code、dept_name、dept_source_code如果同时存在，优先级依次降低
dept_source_code	VARCHAR(100)	否	归属部门第三方唯一标识，多个值以“,”分隔。dept_id、dept_code、dept_name、dept_source_code如果同时存在，优先级依次降低

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

# bC活动报名回调接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bcwin/v1/applyCallBack/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "campaign_source_code": "6675329105525724449",
    "campaign_code": "BC20240101",
    "cm_ids": "20240101,20240101,20240101",
    "cm_codes": "",
    "cm_names": "",
    "registered_time": "2024-01-01 10:12:12",
    "merchant_information": ""
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
campaign_source_code	VARCHAR(100)	是	第三方活动唯一标识。通过此唯一标识匹配
campaign_code	VARCHAR(100)	是	活动编号
cm_ids	TEXT	否	多个值用“,”分隔；客户ID、客户编码、客户名称不能同时为空，如果同时存在，优先级依次降低
cm_codes	TEXT	否	多个值用“,”分隔；客户ID、客户编码、客户名称不能同时为空，如果同时存在，优先级依次降低
cm_names	TEXT	否	多个值用“,”分隔；客户ID、客户编码、客户名称不能同时为空，如果同时存在，优先级依次降低
registered_time	VARCHAR(32)	是	报名成功时间。格式：yyyy-mm-dd hh:mm:ss
merchant_information	TEXT	是	报名时对应商家信息

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

# 查询bc活动

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/bcwin/v1/queryCampaign/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "activity_source_code": "",
    "activity_code": "",
    "before_create_time": "",
    "after_create_time": "",
    "before_modify_time": "",
    "after_modify_time": "",
    "activity_type_code": ""
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
activity_source_code	VARCHAR(32)	否	第三方活动唯一标识
activity_code	VARCHAR(32)	否	活动编号
before_create_time	VARCHAR(32)	否	创建时间之前,格式：yyyy-MM-dd HH:mm:ss
after_create_time	VARCHAR(32)	否	创建时间之后,格式：yyyy-MM-dd HH:mm:ss
before_modify_time	VARCHAR(32)	否	修改时间之前,格式：yyyy-MM-dd HH:mm:ss
after_modify_time	VARCHAR(32)	否	修改时间之后,格式：yyyy-MM-dd HH:mm:ss
activity_type_code	VARCHAR(32)	否	活动类型编码

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
      "activity_source_code": "",
      "activity_code": "",
      "activity_type_code": "",
      "activity_type_name": "",
      "activity_name": "",
      "start_date": "",
      "end_date": "",
      "event_status": "",
      "event_information": "",
      "register_url": "",
      "belong_dept": [
        {
          "id": "",
          "code": "",
          "name": ""
        }
      ],
      "override_customer": [
        {
          "id": "",
          "code": "",
          "name": "",
          "source_code": ""
        }
      ],
      "invited_customer": [
        {
          "id": "",
          "code": "",
          "name": "",
          "source_code": ""
        }
      ],
      "registered_customer": [
        {
          "id": "",
          "code": "",
          "name": "",
          "source_code": "",
          "merchant_information": ""
        }
      ]
    }
]

参数说明：

参数	类型	必填	说明
activity_source_code	VARCHAR(32)	否	第三方活动唯一标识
activity_code	VARCHAR(32)	否	活动编号
activity_type_code	VARCHAR(32)	否	活动类型编码
activity_type_name	VARCHAR(32)	否	活动类型名称
activity_name	VARCHAR(100)	否	活动名称
start_date	VARCHAR(32)	否	活动开始日期，精确到天
end_date	VARCHAR(32)	否	活动结束日期，精确到天
event_status	VARCHAR(32)	否	活动状态，1：已上线，2：中止，3：结束
event_information	VARCHAR(32)	否	活动信息
register_url	VARCHAR(100)	否	活动报名URL
belong_dept	List		归属部门列表
belong_dept.id	VARCHAR(32)	否	归属部门ID
belong_dept.code	VARCHAR(32)	否	归属部门编码
belong_dept.name	VARCHAR(32)	否	归属部门名称
override_customer	List		覆盖客户列表
override_customer.id	VARCHAR(32)	否	覆盖客户-客户id
override_customer.code	VARCHAR(32)	否	覆盖客户-客户编码
override_customer.name	VARCHAR(32)	否	覆盖客户-客户名称
override_customer.source_code	VARCHAR(32)	否	覆盖客户-客户第三方id
invited_customer	List		已通知客户列表
invited_customer.id	VARCHAR(32)	否	已通知客户-客户id
invited_customer.code	VARCHAR(32)	否	已通知客户-客户编码
invited_customer.name	VARCHAR(32)	否	已通知客户-客户名称
invited_customer.source_code	VARCHAR(32)	否	已通知客户-客户第三方id
registered_customer	List		已报名客户列表
registered_customer.id	VARCHAR(32)	否	已报名客户-客户id
registered_customer.code	VARCHAR(32)	否	已报名客户-客户编码
registered_customer.name	VARCHAR(32)	否	已报名客户-客户名称
registered_customer.source_code	VARCHAR(32)	否	已报名客户-客户第三方id
registered_customer.merchant_information	TEXT	否	商家信息

← 幸运抽奖接口一物一码接口 →