# 标签管理接口

# 获取标签列表

GET https://hub.juzibot.com/api/v1/tag/list?token=***

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
  data:[
   {
     id: 'et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ',
     name: '标签组名',
     createTimestamp: 1601274190000,
     order: 0,
     tags:[{
       id: 'etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw',
       name: '标签名',
       createTimestamp: 1601274190000,
       order: 0,
     }]
   }
  ]
}

# 返回参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容
data.id string 标签组id
data.name string 标签组名
data.createTimestamp number 标签组创建时间戳(毫秒),0表示目前没有
data.order number 标签组排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)
data.tag.id string 标签id
data.tag.name string 标签名
data.tag.createTimestamp number 标签创建时间戳(毫秒),0表示目前没有
data.tag.order number 标签排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)

TIP

创建时间戳为0时,表示不存在,同步之后就会有

# 获取标签详情

GET https://hub.juzibot.com/api/v1/tag/detail?token=***&tagId=etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
tagId string 标签id

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
  data:[
   {
     id: 'et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ',
     name: '标签组名',
     createTimestamp: 1601274190000,
     order: 0,
     tags:[{
       id: 'etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw',
       name: '标签名',
       createTimestamp: 1601274190000,
       order: 0,
     }]
   }
  ]
}

# 返回参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容
data.id string 标签组id
data.name string 标签组名
data.createTimestamp number 标签组创建时间戳(毫秒),0表示目前没有
data.order numbe 是r 标签组排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)
data.tag.id string 标签id
data.tag.name string 标签名
data.tag.createTimestamp number 标签创建时间戳(毫秒),0表示目前没有
data.tag.order number 标签排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)

WARNING

创建时间戳为0时,表示不存在,同步之后就会有

# 创建标签

POST https://hub.juzibot.com/api/v1/tag/create?token=***

# 请求示例:

{
  groupId: 'et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ',
  groupName: '标签组名',
  tag: [{
    name: '标签名',
  }]
}

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
groupId string 标签组id
groupName string 标签组名称,最长为30个字符
tag.name string 新的标签名称,最长为30个字符

TIP

  1. 如果要向指定的标签组下添加标签,需要填写group_id参数;如果要创建一个全新的标签组以及标签,则需要通过group_name参数指定新标签组名称,如果填写的groupname已经存在,则会在此标签组下新建标签。
  2. 如果填写了group_id参数,则group_name参数会被忽略。
  3. 不支持创建空标签组。
  4. 标签组内的标签不可同名,如果传入多个同名标签,则只会创建一个。

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
  data:[
   {
     id: 'et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ',
     name: '标签组名',
     createTimestamp: 1601274190000,
     order: 0,
     tags:[{
       id: 'etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw',
       name: '标签名',
       createTimestamp: 1601274190000,
       order: 0,
     }]
   }
  ]
}

# 参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容
data.id string 标签组id
data.name string 标签组名
data.createTimestamp number 标签组创建时间戳(毫秒),0表示目前没有
data.order number 标签组排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)
data.tags.id string 标签id
data.tags.name string 标签名
data.tags.createTimestamp number 标签创建时间戳(毫秒),0表示目前没有
data.tags.order number 标签排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)

TIP

创建时间戳为0时,表示不存在,同步之后就会有

# 参数说明:

错误码 说明
-1 标签组名称无效
-2 标签组无权限,即api接口无法更改句客宝创建的标签组
-3 标签组名字超过限定长度
-4 标签名字超过限定长度

# 修改标签组

POST https://hub.juzibot.com/api/v1/tagGroup/edit?token=***

# 请求示例:

{
  id: 'et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ',
  name: '标签组名',
  order: 123
}

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
id string 标签组id
name string 标签组名称,最长为30个字符
order number 标签组的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)

TIP

  1. name 和 order 不可同时为空
  2. 修改后的标签组不能和已有的标签组重名,标签也不能和同一标签组下的其他标签重名。

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

# 参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容

# 参数说明:

错误码 说明
-2 标签组无权限,即api接口无法更改句客宝创建的标签组
-3 标签组名字超过限定长度
-4 标签名字超过限定长度

# 修改标签

POST https://hub.juzibot.com/api/v1/tag/edit?token=***

# 请求示例:

{
  id: 'etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw',
  name: '标签名',
  order: 123
}

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
id string 标签id
name string 标签名称,最长为30个字符
order number 标签的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)

TIP

  1. name 和 order 不可同时为空
  2. 修改后的标签组不能和已有的标签组重名,标签也不能和同一标签组下的其他标签重名。

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

# 参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容

# 参数说明:

错误码 说明
-2 标签组无权限,即api接口无法更改句客宝创建的标签组
-4 标签名字超过限定长度

# 删除标签组

POST https://hub.juzibot.com/api/v1/tagGroup/delete?token=***

# 请求示例:

{
  id: ['et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ']
}

# 请求示例:

名称 类型 是否必须 备注
token string 调用接口凭证
id string[] 标签组id列表

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

# 参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容

# 参数说明:

错误码 说明
-2 标签组无权限,即api接口无法更改句客宝创建的标签组

# 删除标签

POST https://hub.juzibot.com/api/v1/tag/delete?token=***

# 请求示例:

{
  id: ['etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw']
}

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
id string[] 标签id列表

WARNING

如果一个标签组下所有的标签均被删除,则标签组会被自动删除。

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

# 参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容

# 参数说明:

错误码 说明
-2 标签组无权限,即api接口无法更改句客宝创建的标签组

# 编辑客户企业标签

POST https://hub.juzibot.com/api/v1/tag/mark?token=***

# 请求示例:

{
  mark_list: [{
    unionId: "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
    userId: 'rocky',
    addTagId: ['etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw'],
    delTagId: ['etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw']
  }]
}

# 请求参数:

名称 类型 是否必须 备注
token string 调用接口凭证
mark_list.unionId string 客户unionId
mark_list.userId string 成员id
mark_list.addTagId string[] 添加标签列表
mark_list.delTagId string[] 移除标签列表

TIP

  1. 请确保unionId是userid的外部联系人。
  2. add_tag和remove_tag不可同时为空。
  3. 同一个标签组下现已支持多个标签

# 返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

# 参数说明:

参数 类型 必定存在 备注
errcode number 返回码
errmsg string 对返回码的文本描述内容
最近更新: 2022/5/6 上午10:51:34