客户中心

1、接口声明

在调用接口时必须在https请求的header中携带"token"参数。

token是智齿客服接口开放平台全局唯一的接口调用凭据。
开发者在调用各业务接口时都需使用token，开发者需要进行妥善保存。token的存储至少要保留32个字符空间。token的有效期目前为24个小时，需定时刷新，或根据接口返回的token失效提示，进行重新获取。请求token接口，无论token是否存在，都会返回新的token，并重置token的过期时间(目前24小时)。

token使用方式说明：
1、开发者需要统一获取和管理token，在调用智齿客服各个业务开放接 口时都应该使用同一个的token，不应该每个业务都刷新获取新的 token，否则容易导致token失效，影响接口的正常调用；
2、目前token的有效期通过返回的expire_in来传达，目前是86400 秒之内的值。开发者需要根据这个有效时间提前去刷新新token。
3、开发者需要根据接口返回的token失效提示，进行重新获取token。

2、接口调用

2.1、获取访问token编码

接口说明：

获取API开放接口token，此token仅适用于智齿开放平台 5.0版本全部API接口 。API接口中的参数 appid, app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

https://www.sobot.com/api/get_token

请求参数：

返回参数：

item对象：

时间戳转换参考工具：

http://tool.chinaz.com/Tools/unixtime.aspx

sign签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34

返回示例：

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.2、创建客户信息

接口说明：

创建客户信息，根据优先级：对接ID>邮箱>手机查找，查询到客户已存在则直接返回，否则新建。

备注：

1、如果企业设置了客户自定义字段，那么在创建客户信息时可以选择查询相对应的自定义字段配置信息进行扩展信息的添加。

请求方式：

POST

请求地址：

/api/crm/5/user/save_user

请求参数：

extend_field_params对象：

返回参数：

请求示例：

curl https://www.sobot.com/api/crm/5/user/save_user 
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{"user_nick":"客户09104",
    "user_emails":"test09104@163.com",
    "extend_field_params":[{
        "fieldid":"df72cdd10a7b4c8da40cd2fd14fed7b6",
        "field_value":"文本框值value4"
        }]
    }'

返回示例：

{
  "item": {
    "companyid": "6573198191ad4b17a0173c9bb1b012fe",
    "user_nick": "客户09104",
    "userid": "b2e959ff879a492b8ec5ca9b503a7414"
  },
  "ret_code": "000000",
  "ret_msg": "操作成功"
}

2.3、编辑客户信息

接口说明：

编辑客户信息

备注：

1、如果企业设置了客户自定义字段，那么在更新客户信息时可以选择查询相对应的自定义字段配置信息进行扩展信息的添加。

请求方式：

POST

请求地址：

/api/crm/5/user/update_user

请求参数：

extend_field_params对象：

返回参数：

请求示例：

curl https://www.sobot.com/api/crm/5/user/update_user -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' -d '{"user_nick":"客户-09102","userid ":"4fcf2a15b47f4e56a474a96fb53923af"}'

返回示例：

{
    "item": {
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "user_nick": "客户-09102",
        "userid": "4fcf2a15b47f4e56a474a96fb53923af" 
   	 },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.4、根据邮箱查询客户信息

接口说明：

根据邮箱查询客户信息

请求方式：

GET

请求地址：

/api/crm/5/user/get_user_by_email

请求参数：

返回参数：

item对象：

extend_field_values对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/get_user_by_email?user_emails=test@sobot.com

返回示例：

{
    "item": {
        "create_agentid": "b23134ejk727618ec5ca9b50327s4",
        "update_agentid": "b23134ejk727618ec5ca9b50327s4",
        "create_datetime": "2019-10-08 16:37:50",
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "extend_field_values": [
            {
                "field_type": "1",
                "field_value": "test",
                "fieldid": "df72cdd10a7b4c8da40cd2fd14fed7b6"
            },
            {
                "field_type": "3",
                "field_value": "20190807",
                "fieldid": "2ac6731170c14feeb77f61ff0b84f399"
            }
        ],
        "user_emails": "test@sobot.com",
        "user_level": "1",
        "user_nick": "我是VIP",
        "user_status": "0",
        "user_tels": "13241089563",
        "userid": "ebe6a8b6bcf840418b8e58d123262945",
        "vip_level": "a87394d63a16488fbbe0b58479586404"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.5、根据手机号查询客户信息

接口说明：

根据手机号查询客户信息

请求方式：

GET

请求地址：

/api/crm/5/user/get_user_by_tel

请求参数：

返回参数：

item对象：

extend_field_values对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/get_user_by_tel?user_tels=13241089563

返回示例：

{
    "item": {
        "create_agentid": "b23134ejk727618ec5ca9b50327s4",
        "update_agentid": "b23134ejk727618ec5ca9b50327s4",
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "create_datetime": "2019-10-08 16:37:50",
        "extend_field_values": [
            {
                "field_type": "1",
                "field_value": "test",
                "fieldid": "df72cdd10a7b4c8da40cd2fd14fed7b6"
            },
            {
                "field_type": "3",
                "field_value": "20190807",
                "fieldid": "2ac6731170c14feeb77f61ff0b84f399"
            }
        ],
        "user_emails": "test@sobot.com",
        "user_level": "1",
        "user_nick": "我是VIP",
        "user_status": "0",
        "user_tels": "13241089563",
        "userid": "ebe6a8b6bcf840418b8e58d123262945",
        "vip_level": "a87394d63a16488fbbe0b58479586404"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.6、根据客户ID查询客户信息

接口说明：

根据客户ID查询客户信息

请求方式：

GET

请求地址：

/api/crm/5/user/get_user_by_id

请求参数：

返回参数：

item对象：

extend_field_values对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/get_user_by_id?userid=ebe6a8b6bcf840418b8e58d123262945

返回示例：

{
    "item": {
        "create_agentid": "b23134ejk727618ec5ca9b50327s4",
        "update_agentid": "b23134ejk727618ec5ca9b50327s4",
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "create_datetime": "2019-10-08 16:37:50",
        "extend_field_values": [
            {
                "field_type": "1",
                "field_value": "test",
                "fieldid": "df72cdd10a7b4c8da40cd2fd14fed7b6"
            },
            {
                "field_type": "3",
                "field_value": "20190807",
                "fieldid": "2ac6731170c14feeb77f61ff0b84f399"
            }
        ],
        "user_emails": "test@sobot.com",
        "user_level": "1",
        "user_nick": "我是VIP",
        "user_status": "0",
        "user_tels": "13241089563",
        "userid": "ebe6a8b6bcf840418b8e58d123262945",
        "vip_level": "a87394d63a16488fbbe0b58479586404"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.7、根据对接ID查询客户信息

接口说明：

根据对接ID查询客户信息

请求方式：

GET

请求地址：

/api/crm/5/user/get_user_by_partnerid

请求参数：

返回参数：

item对象：

extend_field_values对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/get_user_by_partnerid?partnerid=oaSvz0M-x1frUqUM5QFj806YwJjo

返回示例：

{
    "item": {
        "create_agentid": "b23134ejk727618ec5ca9b50327s4",
        "update_agentid": "b23134ejk727618ec5ca9b50327s4",
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "create_datetime": "2019-10-08 16:37:50",
        "extend_field_values": [
            {
                "field_type": "1",
                "field_value": "test",
                "fieldid": "df72cdd10a7b4c8da40cd2fd14fed7b6"
            },
            {
                "field_type": "3",
                "field_value": "20190807",
                "fieldid": "2ac6731170c14feeb77f61ff0b84f399"
            }
        ],
        "user_emails": "test@sobot.com",
        "user_level": "1",
        "user_nick": "我是VIP",
        "user_status": "0",
        "user_tels": "13241089563",
        "userid": "ebe6a8b6bcf840418b8e58d123262945",
        "vip_level": "a87394d63a16488fbbe0b58479586404"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.8、查询客户列表

接口说明：

查询客户列表

请求方式：

GET

请求地址：

/api/crm/5/user/query_users

请求参数：

返回参数：

items对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/query_users?start_datetime=2018-01-22 00:00:00&end_datetime=2019-05-25 23:59:59&page_no=1&page_size=10

返回示例：

{
    "items": [
        {
            "create_agentid": "b23134ejk727618ec5ca9b50327s4",
            "update_agentid": "b23134ejk727618ec5ca9b50327s4",
            "companyid": "6573198191ad4b17a0173c9bb1b012fe",
            "create_datetime": "2019-10-08 16:37:50",
            "enterpriseid": "",
            "partnerid": "",
            "remark": "",
            "user_emails": "test@sobot.com ",
            "user_level": "1",
            "user_nick": "我是VIP",
            "user_status": "0",
            "user_tels": "13241089563",
            "userid": "ebe6a8b6bcf840418b8e58d123262945",
            "vip_level": "a87394d63a16488fbbe0b58479586404"
        }
    ],
    "page_count": 1,
    "page_no": 1,
    "page_size": 10,
    "totalcount": 1,
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.9、查询客户自定义字段信息

接口说明：

查询客户自定义字段配置信息

备注：

1、此处查询为客户自定义字段配置信息，如需要获取某一个客户相对应的自定义字段值时需要请求独立接口。

请求方式：

GET

请求地址：

/api/crm/5/user/query_user_extend_fields

请求参数：

返回参数：

item对象:

extend_fields对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/query_user_extend_fields

返回示例：

 {
    "item": {
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "extend_fields": [
            {
                "companyid": "6573198191ad4b17a0173c9bb1b012fe",
                "field_name": "单行文本",
                "field_status": "1",
                "field_type": "1",
                "field_variable": "customField1",
                "fieldid": "df72cdd10a7b4c8da40cd2fd14fed7b6",
                "fill_flag": "1",
                "open_flag": "1",
                "operate_type": "1",
                "remark": "单行文本",
                "sort_no": "1"
            },
            {
                "companyid": "6573198191ad4b17a0173c9bb1b012fe",
                "field_name": "日期",
                "field_status": "1",
                "field_type": "3",
                "field_variable": "customField2",
                "fieldid": "2ac6731170c14feeb77f61ff0b84f399",
                "fill_flag": "0",
                "open_flag": "1",
                "operate_type": "1",
                "remark": "日期",
                "sort_no": "2"
            }
        ],
        "operate_type": "1"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.10、查询自定义字段值

接口说明：

返回自定义字段结果值信息，用于数据展示。

请求方式：

GET

请求地址：

/api/crm/5/user/query_user_extend_field_values

请求参数：

返回参数：

item对象:

extend_field_values对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/query_user_extend_field_values?userid=ebe6a8b6bcf840418b8e58d123262945

返回示例：

{
    "item": {
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "extend_field_values": [
            {
                "field_type": "1",
                "field_value": "test",
                "fieldid": "df72cdd10a7b4c8da40cd2fd14fed7b6"
            },
            {
                "field_type": "3",
                "field_value": "20190807",
                "fieldid": "2ac6731170c14feeb77f61ff0b84f399"
            }
        ],
        "userid": "ebe6a8b6bcf840418b8e58d123262945"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.11、查询客户固定字段信息

接口说明：

查询客户固定字段配置信息

备注：

1、此处查询为客户固定字段配置信息，例如，VIP级别。

请求方式：

GET

请求地址：

/api/crm/5/user/query_user_fixed_extend_fields

请求参数：

返回参数：

item对象:

extend_fields对象：

field_data_info_list字段：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/query_user_fixed_extend_fields

返回示例：

{
    "item": {
        "companyid": "6573198191ad4b17a0173c9bb1b012fe",
        "extend_fields": [
            {
                "companyid": "6573198191ad4b17a0173c9bb1b012fe",
                "field_data_info_list": [
                    {
                        "data_name": "VIP1",
                        "data_value": "a87394d63a16488fbbe0b58479586404",
                        "dataid": "fd8a11a04366448cb62cc13df5fb956b"
                    }
                ],
                "field_name": "VIP等级",
                "field_status": "1",
                "field_type": "6",
                "field_variable": "vipLevel",
                "fieldid": "05bcdc56e68149d1841962caf593d077",
                "fill_flag": "0",
                "open_flag": "1",
                "operate_type": "11",
                "remark": "可对VIP级别设置1-20个级别,用于客户分类管理。",
                "sort_no": "2"
            }
        ],
        "operate_type": "11"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.12、查询客户中心企业列表

接口说明：

查询客户中心的企业列表

请求方式：

GET

请求地址：

/api/crm/5/user/query_enterprises

请求参数：

返回参数：

items对象：

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/crm/5/user/query_enterprises?start_datetime=2018-01-22 00:00:00&end_datetime=2019-05-25 23:59:59&page_no=1&page_size=10

返回示例：

{
    "items": [
        {
            "companyid": "626632d761be4da2a33c7f26f6e50b41",
            "create_datetime": "2019-10-08 16:37:50",
            "enterprise_name": "智齿科技",
            "enterpriseid": "67bf196859424a1dbebaf0e76c994636"
        }
    ],
    "page_count": 1,
    "page_no": 1,
    "page_size": 15,
    "ret_code": "000000",
    "ret_msg": "操作成功",
    "total_count": 3
}

2.13、客户批量上传接口

接口说明：

客户批量上传接口，一次最多50条。 创建客户信息，如果根据手机号、邮箱查询到客户已存在则直接返回，否则新建。

备注：如果企业设置了客户自定义字段，那么在创建客户信息时可以选择查询相对应的自定义字段配置信息进行扩展信息的添加。

请求方式：

POST

请求地址：

/api/crm/5/user/save_user_batch

请求参数：

请求参数为list集合

extend_field_params对象：

返回参数

请求示例

curl https://www.sobot.com/api/crm/5/user/save_user_batch -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d ' [
    {
        "user_nick": "客户09104",
        "user_emails": "test09104@163.com",
        "extend_field_params":[{
        "fieldid":"df72cdd10a7b4c8da40cd2fd14fed7b6",
        "field_value":"文本框值value4"
        }]
    },
    {
        "user_nick": "客户09105",
        "user_emails": "test09105@163.com",
        "extend_field_params":[{
        "fieldid":"df72cdd10a7b4c8da40cd2fd14fed7b6",
        "field_value":"文本框值value4"
        }]
    }
] '

返回示例

//全部导入成功：
{
    "items": [
        {
            "companyid": "7cbccb7cbc9646f7a98cdd8df7ffa645",
            "result_flag": "SUCCESS",
            "user_nick": "客户09104",
            "userid": "8c773d37e3504be5bc80d4038c7c7c98"
        },
        {
            "companyid": "7cbccb7cbc9646f7a98cdd8df7ffa645",
            "result_flag": "SUCCESS",
            "user_nick": "客户09105",
            "userid": "fdf9b27a7d784c459bc50d37e90bc869"
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

//部分导入成功：
{
    "items": [
        {
            "companyid": "7cbccb7cbc9646f7a98cdd8df7ffa645",
            "result_flag": "SUCCESS",
            "user_nick": "客户09104",
            "userid": "8c773d37e3504be5bc80d4038c7c7c98"
        },
        {
            "companyid": "7cbccb7cbc9646f7a98cdd8df7ffa645",
            "error_info": "用户昵称，不允许为空!",
            "result_flag": "FAIL"
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

3、状态编码

3.1、操作成功

业务操作成功。

3.2、系统异常

系统服务异常。

3.3、业务异常

业务异常。