开放平台API

# 渠道活码管理相关接口

# 创建渠道活码

请求方式：POST

请求地址：https://$basehost/gateway/eaopen/AddWwChannelLiveCode

body参数：

{
  "ww_channel_live_code":{
      "name" : "渠道活码名称",
      "ww_user_id_list":["wog2gXCwAA7Ou29pP0C-Dsr7NZ0IV6UA"],
      "channel_str_id": "5fcbeaec0f8b7c3091354c2d9dc35d0a",
      "need_verify": false, 
      "user_head_url": "https://img2.baidu.com/it/u=2425096427,1551552845&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500"
  }
}
字段 类型 必填 说明
name string 是 渠道活码名称，不能超过30个字符
ww_user_id_list array 是 活码关联的企微成员id数组
channel_str_id string 否 关联的渠道唯一id
need_verify bool 否 外部客户添加时是否需要验证 true需要 false 不需要 默认值为false
user_head_url string 否 活码头像地址

返回值：

{
    "data": {
        "ww_channel_live_code":{
              "str_id": "3349ac6efe0f76194b93b2ed8157cf87",
              "name" : "渠道活码名称",
              "ww_user_id_list":["wog2gXCwAA7Ou29pP0C-Dsr7NZ0IV6UA"],
              "channel_str_id": "5fcbeaec0f8b7c3091354c2d9dc35d0a",
              "need_verify": false, 
              "user_head_url": "https://img2.baidu.com/it/u=2425096427,1551552845&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500",
              "state_code": "e645526e76cf4e1ea15d188f90e0",
              "qr_code_url": "https://quan00-1259287960.cos.ap-guangzhou.myqcloud.com/2000772/502351e95caf449ca510a8abcfc9b02f"    
      }
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

返回说明

字段 类型 说明
errcode int 状态码，0为正常，非0代表错误
errmsg string 错误信息
data json json返回值
   ww_channel_live_code object 渠道活码
     str_id string 活码唯一id
     name string 活码名称
     ww_user_id_list array 活码关联企微成员id数组
     channel_str_id string 关联的渠道唯一id
     need_verify bool
     state_code string 企微联系我自定义的state参数
     qr_code_url string 活码二维码地址
     ww_config_id string 企微config_id
hint string 请求日志ID

# 修改渠道活码

请求方式：POST

请求地址：https://$basehost/gateway/eaopen/SetWwChannelLiveCode

body参数：

{
  "ww_channel_live_code":{
      "str_id": "3349ac6efe0f76194b93b2ed8157cf87",
      "name" : "渠道活码名称",
      "ww_user_id_list":["wog2gXCwAA7Ou29pP0C-Dsr7NZ0IV6UA"],
      "channel_str_id": "5fcbeaec0f8b7c3091354c2d9dc35d0a",
      "need_verify": false, 
      "user_head_url": "https://img2.baidu.com/it/u=2425096427,1551552845&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500"
  }
}

返回值：

{
    "data": {
        "ww_channel_live_code": {
              "str_id": "3349ac6efe0f76194b93b2ed8157cf87",
              "name" : "渠道活码名称",
              "ww_user_id_list":["wog2gXCwAA7Ou29pP0C-Dsr7NZ0IV6UA"],
              "channel_str_id": "5fcbeaec0f8b7c3091354c2d9dc35d0a",
              "need_verify": false, 
              "user_head_url": "https://img2.baidu.com/it/u=2425096427,1551552845&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500",
              "state_code": "e645526e76cf4e1ea15d188f90e0",
              "qr_code_url": "https://quan00-1259287960.cos.ap-guangzhou.myqcloud.com/2000772/502351e95caf449ca510a8abcfc9b02f"    
        }
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

# 获取渠道活码列表

请求方式：POST

请求地址：https://$basehost/gateway/eaopen/GetWwChannelLiveCodeList

body参数：

{
    "offset": 0,
    "limit": 10
}
字段 类型 必填 说明
offset int 否 每次获取的的开始位置，最小值为0
limit int 是 每次获取的条数，取值范围（1～100）

返回值：

{
    "data": {
        "has_more": true,
        "list": [
            {
                "str_id": "3349ac6efe0f76194b93b2ed8157cf87",
                "name" : "渠道活码名称",
                "ww_user_id_list":["wog2gXCwAA7Ou29pP0C-Dsr7NZ0IV6UA"],
                "channel_str_id": "5fcbeaec0f8b7c3091354c2d9dc35d0a",
                "need_verify": false, 
                "user_head_url": "https://img2.baidu.com/it/u=2425096427,1551552845&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500",
                "state_code": "e645526e76cf4e1ea15d188f90e0",
                "qr_code_url": "https://quan00-1259287960.cos.ap-guangzhou.myqcloud.com/2000772/502351e95caf449ca510a8abcfc9b02f",
                "ww_config_id": "xxxxxxx"
            }
        ]
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

返回说明

字段 类型 说明
errcode int 状态码，0为正常，非0代表错误
errmsg string 错误信息
data json json返回值
   has_more bool 是否还有更多
   list array 渠道活码数组列表
hint string 请求日志ID

# 删除渠道活码

请求方式：POST

请求地址：https://$basehost/gateway/eaopen/DelWwChannelLiveCode

body参数：

{
    "str_id": "3349ac6efe0f76194b93b2ed8157cf87"
}
字段 类型 必填 说明
str_id string 是 渠道活码唯一id

返回值：

{
    "data": {
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

# 获取渠道活码详情

请求方式：POST

请求地址：https://$basehost/gateway/eaopen/GetWwChannelLiveCode

body参数：

{
    "str_id": "3349ac6efe0f76194b93b2ed8157cf87"
}
字段 类型 必填 说明
str_id string 是 渠道活码唯一id

返回值：

{
    "data": {
      "ww_channel_live_code": {
            "str_id": "3349ac6efe0f76194b93b2ed8157cf87",
            "name" : "渠道活码名称",
            "ww_user_id_list":["wog2gXCwAA7Ou29pP0C-Dsr7NZ0IV6UA"],
            "channel_str_id": "5fcbeaec0f8b7c3091354c2d9dc35d0a",
            "need_verify": false, 
            "user_head_url": "https://img2.baidu.com/it/u=2425096427,1551552845&fm=253&fmt=auto&app=138&f=JPEG?w=500&h=500",
            "state_code": "e645526e76cf4e1ea15d188f90e0",
            "qr_code_url": "https://quan00-1259287960.cos.ap-guangzhou.myqcloud.com/2000772/502351e95caf449ca510a8abcfc9b02f",
            "ww_config_id": "xxxxxxx"
      }
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}
最后更新时间: 2023/8/15 10:25:21

← 创建红包模板 →