帮我吧文档:数据接口:客户管理:客户分组

客户分组接口

该模块接口同时支持公司分组(2B模式)和联系人分组(2C模式)。

JSON格式

名称 类型 只读 必填 注释
groupId int 分组ID,系统自动生成
url varchar 该分组的资源url
groupName varchar 分组名称
type tinyint 分组类型,取值为:1-公司分组,2联系人分组

JSON示例

{
     "groupId": 1,
     "url": "https://www.bangwo8.com/api/v1/customergroups/1.json",
     "groupName": "VIP客户",
     "type":1
}

获取分组列表

GET /api/v1/customergroups.json

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/customergroups.json \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
	"customergroups": [
		{
			"groupId": 1,
                        "groupName": "VIP客户",
                        "type":1
		},
		{
			"groupId": 2,
                        "groupName": "优质客户",
                        "type":1
		}
	]
}

查看指定分组信息

GET /api/v1/customergroups/{id}.json

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/customergroups/{id}.json \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
  "customergroup": {
	"groupId": 1,
        "groupName": "VIP客户",
        "type":1
   }
}

获取多个分组信息

GET /api/v1/customergroups/show_many.json?ids={ids}

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/customergroups/show_many.json?ids=1,2 \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
  "customergroups": [
     {
	"groupId": 1,
        "groupName": "VIP客户",
        "type":1
    },
    {
        "groupId": 2,
        "groupName": "优质客户",
        "type":1
    }
  ]
}

创建分组

POST /api/v1/customergroups.json

调用者权限

管理员

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/customergroups.json \
  -H "Content-Type: application/json" -X POST -d '{"customergroup": {"groupName": "VIP客户","type": "1"}}'

说明:创建分组时,cgName和type必填。

返回值示例

Status: 200 OK
Location: https://www.bangwo8.com/api/v1/customergroups/{id}.json

{
  "customergroups": {
	"groupId": 1,
        "groupName": "VIP客户",
        "type":1
    }
}

修改分组信息

PUT /api/v1/customergroups/{id}.json

调用者权限

管理员

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/customergroups/123.json \
  -H "Content-Type: application/json" -X PUT -d '{"customergroup": {"groupName": "优质客户"}}'

返回值示例

Status: 200 OK

{
  "customergroup":  {
	"groupId": 1,
        "groupName": "优质客户",
        "type":1
    }
}

获取指定分组的客户列表

GET /api/v1/customergroups/{id}/customers.json

说明:2B模式下返回的是公司列表,2C模式下返回的是联系人列表

调用者权限

所有客服

调用示例

curl https://www.bangwo8.com/api/v1/customergroups/{id}/customers.json \
  -v -u {account}:{password}

返回值示例
2B模式下返回公司列表,具体可参考获取公司列表

Status: 200 OK

{
  "customers": [
		{
			"uId": 1,
			"companyName": "测试公司1",
			...
		},
		{
			"uId": 2,
			"companyName": "测试公司2",
			...
		}
	]
}

2C模式下返回联系人列表,具体可参考获取联系人列表

Status: 200 OK

{
  "customers": [
		{
			"cId": 1,
			"name": "张三",
			...
		},
		{
			"cId": 2,
			"name": "李四",
			...
		}
	]
}

页面工具