<small id="aimcq"></small>
  • # 客戶中心

    # 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

    請求地址:

    http://www.gene-tech.cn/api/get_token

    請求參數:

    參數 類型 必填 名稱 備注
    appid String 接口憑證Id 第三方用戶接口調用唯一憑證id
    create_time String 時間戳 時間戳,秒,例如 2019-09-25 15:49:33 的時間戳1569397773
    sign String 簽名 md5(appid+create_time+app_key) sign簽名,app_key為秘鑰

    返回參數:

    參數 類型 必填 名稱
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 必填 名稱 備注
    token String token編碼
    expires_in String 憑證有效時間 單位:秒

    時間戳轉換參考工具:

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

    sign簽名生成示例:

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

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

    請求示例:

    curl http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    user_nick String 客戶昵稱
    user_name String 客戶名稱
    user_tels String 手機號碼 如多號碼請采用英文分號";"隔開
    user_emails String 郵箱 如多郵箱請采用英文分號";"隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項id,通過接口查詢客戶固定字段信息獲取
    user_label String 客戶標簽 如多標簽用英文分號";"隔開
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    enterprise_name String 企業名稱 企業名稱請填寫全稱,非簡稱
    partnerid String 對接ID
    extend_field_params List 擴展字段信息
    remark String 備注

    extend_field_params對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID

    請求示例:

    curl http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    userid String 客戶ID
    user_nick String 客戶昵稱
    user_name String 客戶名稱
    user_emails String 郵箱 如多郵箱請采用英文分號";"隔開
    user_tels String 手機號碼 如多號碼請采用英文分號";"隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義,參照接口2.0
    user_label String 客戶標簽 如多標簽用英文分號";"隔開
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    extend_field_params List 擴展字段信息
    remark String 備注

    extend_field_params對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID

    請求示例:

    curl http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    user_emails String 客戶郵箱 此參數只允許單一值

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 必填 名稱 備注
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID
    user_emails String 客戶郵箱 此參數可能會采用英文分號";"隔開
    user_name String 客戶名稱
    user_tels String 手機號碼 此參數可能會采用英文分號";"隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    partnerid String 對接ID
    enterpriseid String 企業ID
    enterprise_name String 企業名稱
    create_agentid String 創建者坐席ID
    update_agentid String 更新者者坐席ID
    remark String 備注
    extend_field_values List 擴展字段值
    create_datetime String 創建時間 2018-07-10 00:00:00
    user_label String 客戶標簽 選項客戶自定義

    extend_field_values對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值
    field_text String 擴展字段文本值 針對選項類型的字段
    field_type String 字段類型 1、單行文本2、多行文本3、日期4、時間5、數值6、下拉列表(選項)7、單選框(選項)8、復選框(選項)

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    user_tels String 手機號 此參數只允許單一值

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 必填 名稱 備注
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID
    user_emails String 客戶郵箱 此參數可能會采用英文分號";"隔開
    user_name String 客戶名稱
    user_tels String 手機號碼 此參數可能會采用英文分號";"隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    partnerid String 對接ID
    enterpriseid String 企業ID
    enterprise_name String 企業名稱
    create_agentid String 創建者坐席ID
    update_agentid String 更新者坐席ID
    remark String 備注
    extend_field_values List 擴展字段值
    create_datetime String 創建時間 2018-07-10 00:00:00
    user_label String 客戶標簽 選項客戶自定義

    extend_field_values對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值
    field_text String 擴展字段文本值 針對選項類型的字段
    field_type String 字段類型 1、單行文本2、多行文本3、日期4、時間5、數值6、下拉列表(選項)7、單選框(選項)8、復選框(選項)

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    userid String 客戶ID 此參數只允許單一值

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 必填 名稱 備注
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID
    user_emails String 客戶郵箱 此參數可能會采用英文分號";"隔開
    user_name String 客戶名稱
    user_tels String 手機號碼 此參數可能會采用英文分號";"隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    partnerid String 對接ID
    enterpriseid String 企業ID
    enterprisename String 企業名稱
    create_agentid String 創建者坐席ID
    update_agentid String 更新者坐席ID
    remark String 備注
    extend_field_values List 擴展字段值
    create_datetime String 創建時間 2018-07-10 00:00:00
    user_label String 客戶標簽 選項客戶自定義

    extend_field_values對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值
    field_text String 擴展字段文本值 針對選項類型的字段
    field_type String 字段類型 1、單行文本2、多行文本3、日期4、時間5、數值6、下拉列表(選項)7、單選框(選項)8、復選框(選項)

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    partnerid String 對接ID 此參數只允許單一值

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 必填 名稱 備注
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID
    user_emails String 客戶郵箱 此參數可能會采用英文分號";"隔開
    user_name String 客戶名稱
    user_tels String 手機號碼 此參數可能會采用英文分號";"隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    partnerid String 對接ID
    enterpriseid String 企業ID
    enterprise_name String 企業名稱
    create_agentid String 創建者坐席ID
    update_agentid String 更新者坐席ID
    remark String 備注
    extend_field_values List 擴展字段值
    create_datetime String 創建時間 2018-07-10 00:00:00
    user_label String 客戶標簽 選項客戶自定義

    extend_field_values對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值
    field_text String 擴展字段文本值 針對選項類型的字段
    field_type String 字段類型 1、單行文本2、多行文本3、日期4、時間5、數值6、下拉列表(選項)7、單選框(選項)8、復選框(選項)

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' httpw://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    user_nick String 客戶昵稱
    user_tels String 手機號碼 此參數只允許單一值
    user_emails String 郵箱 此參數只允許單一值
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    enterpriseid String 企業ID 可根據企業列表接口中獲取企業ID
    start_datetime String 開始時間(創建) 2018-07-10 00:00:00
    end_datetime String 結束時間(創建) 2018-07-10 23:59:59
    page_no Integer 起始頁碼 1
    page_size Integer 每頁條數 默認每頁15條

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    items List 對象列表
    page_count Integer 共幾頁
    page_no Integer 起始頁
    page_size Integer 每頁條數
    total_count Integer 數據條數

    items對象:

    參數 類型 必填 名稱 備注
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID
    user_tels String 手機號碼 此參數可能會采用英文分號";"隔開
    user_emails String 郵箱 此參數可能會采用英文分號";"隔開
    user_name String 客戶名稱
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    partnerid String 對接ID
    enterpriseid String 企業ID
    enterprise_name String 企業名稱
    remark String 備注
    create_agentid String 創建者坐席ID
    update_agentid String 更新者坐席ID
    create_datetime String 創建時間 2018-07-10 00:00:00
    user_label String 客戶標簽 選項客戶自定義

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回數據

    item對象:

    參數 類型 必填 名稱 備注
    companyid String 公司ID
    operate_type String 自定義字段類型 客戶自定義字段
    extend_fields List 擴展字段列表

    extend_fields對象:

    參數 類型 必填 名稱 備注
    companyid String 公司ID
    field_name String 字段名稱
    field_status String 字段狀態 0無效(刪除)1有效
    field_type String 字段類型 1、單行文本 input 2、多行文本 textarea 3、日期YYYY-MM-DD 4、時間hh:mm 5、數值 6、下拉列表(選項) 7、復選框(選項) 8、單選框(選項) 9、級聯字段
    field_variable String 字段變量名
    fieldid String 字段ID
    fill_flag String 是否必填 0否1是
    open_flag String 開啟開關 0關閉1 開啟
    operate_type String 自定義字段類型 1、客戶自定義字段 11、客戶固定字段
    sort_no String 排序標識
    remark String 字段描述

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    userid String 客戶ID

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回數據

    item對象:

    參數 類型 必填 名稱 備注
    companyid String 公司ID
    userid String 客戶id
    extend_fields List 擴展字段列表

    extend_field_values對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值
    field_text String 擴展字段文本值 針對選項類型的字段
    field_type String 字段類型 1、單行文本2、多行文本3、日期 2019-09-014、時間 10:20:305、數值6、下拉列表(選項)7、單選框(選項)8、復選框(選項)

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回數據

    item對象:

    參數 類型 必填 名稱 備注
    companyid String 公司ID
    operate_type String 自定義字段類型 客戶自定義字段
    extend_fields List 擴展字段列表

    extend_fields對象:

    參數 類型 必填 名稱 備注
    companyid String 公司ID
    field_name String 字段名稱
    field_status String 字段狀態 0無效(刪除)1有效
    field_type String 字段類型 1、單行文本 input 2、多行文本 textarea 3、日期YYYY-MM-DD 4、時間hh:mm 5、數值 6、下拉列表(選項) 7、復選框(選項) 8、單選框(選項) 9、級聯字段
    field_variable String 字段變量名
    fieldid String 字段ID
    fill_flag String 是否必填 0否1是
    open_flag String 開啟開關 0關閉1 開啟
    operate_type String 自定義字段類型 3、客戶自定義字段 11、客戶固定字段
    sort_no String 排序標識
    remark String 字段描述
    field_data_info_list List 選項數據列表 字段解釋見下表

    field_data_info_list字段:

    參數 類型 必填 名稱 備注
    data_name String 選項名稱
    data_value String 選項值
    dataid String 選項id

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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

    請求參數:

    參數 類型 必填 名稱 備注
    page_no Integer 起始頁碼 1
    page_size Integer 每頁條數 默認每頁15條

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    items List 對象列表
    page_count Integer 共幾頁
    page_no Integer 起始頁
    page_size Integer 每頁條數
    total_count Integer 數據條數

    items對象:

    參數 類型 必填 名稱 備注
    companyid String 公司ID
    enterpriseid String 企業ID
    enterprise_name String 企業名稱
    create_datetime String 創建時間 2018-07-10 00:00:00

    請求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' http://www.gene-tech.cn/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集合

    參數 類型 必填 名稱 備注
    user_nick String 客戶昵稱
    user_name String 客戶名稱
    user_tels String 手機號碼 如多號碼請采用英文逗號","隔開
    user_emails String 郵箱 如多郵箱請采用英文逗號","隔開
    user_level String 客戶等級 0普通,1VIP
    vip_level String VIP級別 選項客戶自定義,參照接口3.1
    user_status String 客戶狀態 0 普通,1 永久拉黑,默認0
    enterprise_name String 企業名稱 企業名稱請填寫全稱,非簡稱
    partnerid String 對接ID
    extend_field_params List 擴展字段信息
    remark String 備注

    extend_field_params對象:

    參數 類型 必填 名稱 備注
    fieldid String 擴展字段ID
    field_value String 擴展字段值

    返回參數

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    userid String 客戶ID
    user_nick String 客戶昵稱
    companyid String 公司ID
    result_flag String 導入是否成功標識 SUCCESS、FAIL
    error_info String 導入失敗信息

    請求示例

    curl http://www.gene-tech.cn/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、操作成功

    業務操作成功。

    狀態編碼 狀態說明
    000000 操作成功(除此編碼以外的編碼為錯誤編碼)

    # 3.2、系統異常

    系統服務異常。

    錯誤編碼 錯誤說明
    900001 token為空
    900002 token已失效,請重新獲取
    900003 signature錯誤
    900004 沒有找到公司的api配置信息
    999999 系統未知異常

    # 3.3、業務異常

    業務異常。

    錯誤編碼 錯誤說明
    500001 客戶昵稱,不允許為空
    500002 VIP級別,傳值超過默認設定值
    500003 VIP級別,企業未維護該字段
    500004 此客戶信息不存在
    500005 客戶信息已存在,不可重復創建
    500006 客戶郵箱格式不對
    500007 客戶ID不允許為空
    500008 客戶標簽狀態未開啟
    500009 客戶標簽,傳值超過默認設定值
    500010 客戶標簽,企業未維護該字段
    500012 超出傳參條數限制
    大星彩票 <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <文本链> <文本链> <文本链> <文本链> <文本链> <文本链>