标签管理接口

获取标签列表

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

请求参数:

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

返回示例:

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

返回参数说明:

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

TIP

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

获取标签详情

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

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
tagIdstring标签id

返回示例:

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

返回参数说明:

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

WARNING

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

创建标签

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

请求示例:

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

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
groupIdstring标签组id
groupNamestring标签组名称,最长为30个字符
tag.namestring新的标签名称,最长为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,
     }]
   }
  ]
}

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
data.idstring标签组id
data.namestring标签组名
data.createTimestampnumber标签组创建时间戳(毫秒),0表示目前没有
data.ordernumber标签组排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)
data.tags.idstring标签id
data.tags.namestring标签名
data.tags.createTimestampnumber标签创建时间戳(毫秒),0表示目前没有
data.tags.ordernumber标签排序的次序值,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
}

请求参数:

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

TIP

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

返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容

参数说明:

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

修改标签

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

请求示例:

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

请求参数:

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

TIP

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

返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容

参数说明:

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

删除标签组

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

请求示例:

{
  id: ['et1LpcCQAAGLd4xufTKt4l9ERbTTQQQQ']
}

请求示例:

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

返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容

参数说明:

错误码说明
-2标签组无权限,即api接口无法更改企业控制台创建的标签组

删除标签

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

请求示例:

{
  id: ['etrRhyBgAAwVm8uMyEc0EMZI1HwmHwmw']
}

请求参数:

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

WARNING

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

返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容

参数说明:

错误码说明
-2标签组无权限,即api接口无法更改企业控制台创建的标签组

编辑客户企业标签

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

请求示例:

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

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
mark_list.unionIdstring客户unionId
mark_list.userIdstring成员id
mark_list.addTagIdstring[]添加标签列表
mark_list.delTagIdstring[]移除标签列表

TIP

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

返回示例:

{
  errcode: 0,
  errmsg: "ok"
}

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
最近更新:
Contributors: windmemory