1. MixService 接口文档

1.1. 创建显示板

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 显示板唯一编号，不填则系统自动生成
name 是 string 显示板名称
description 否 string 描述
type 是 string 显示板类型：pro/app/show/mixmanager
script 是 json 显示板脚本

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
uid string 返回唯一编号

请求示例：

{

    "action": "create_dashboard",
    "uid": "",
    "name": "demo",
    "type": "pro",
    "description": "",
    "script": {}
}

响应示例：

{
    "resp": "create_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14"
    }
}

1.2. 更新显示板

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
id 是 int 表自增编号
uid 是 string 显示板唯一编号
name 是 string 显示板名称
description 否 string 描述
type 是 string 显示板类型：pro/app/show/mixmanager
script 是 json 显示板脚本

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
uid string 唯一编号

请求示例：

{
    "action": "update_dashboard",
    "id": 782,
    "uid": "DSH18915024700782",
    "name": "demo",
    "type": "pro",
    "description": "无",
    "script": {}
}

响应示例：

{
    "resp": "update_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14",
        "is_available": 1,
    }
}

1.3. 删除显示板

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
uid string 唯一编号

请求示例：

{
    "action": "delete_dashboard",
    "uid": "DSH18915071400784"
}

响应示例：

{
    "resp": "delete_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14",
        "is_available": 1,
    }
}

1.4. 获取显示板详情

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
id int 表自增编号
uid string 显示板唯一编号
name string 显示板名称
description string 描述
type string 显示板类型：pro/app/show/mixmanager
script json 显示板脚本
object_list json 绑定对象列表
created int 创建时间
last_modified int 更新时间
is_available int 是否有效

请求示例：

{
    "action": "get_dashboard_item",
    "uid": "DSH18915024700782"
}

响应示例：

{
    "resp": "get_dashboard_item",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
         "object_list": [
            "demo",
            "demo0819"
        ],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14",
        "is_available": 1,
    }
}

1.5. 获取显示板列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
page_index 否 int 页数
page_size 否 int 每页数量
where_and 否 json and查询条件
where_or 否 json or查询条件时间
where_in 否 json in查询条件

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
id int 表自增编号
uid string 显示板唯一编号
name string 显示板名称
description string 描述
type string 显示板类型：pro/app/show/mixmanager
script json 显示板脚本
object_list json 绑定对象列表
created int 创建时间
last_modified int 更新时间
is_available int 是否有效

请求示例：

{
    "action": "get_dashboard_list",
    "page_index": 1,
    "page_size": 1,
    "where_and": [["name","like","%demo%"]],
    "where_or": [["name","like","%demo%"]]
}

响应示例：

{
    "resp": "get_dashboard_list",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "data": [
            {
                "id": 784,
                "uid": "DSH18915071400784",
                "name": "demo",
                "type": "pro",
                "description": "",
                "script": [],
                "object_list": [
                    "demo",
                    "demo0819"
                ],
                "created": "2021-08-19 15:07:14",
                "last_modified": "2021-08-19 15:07:14",
                "is_available": 1,
            }
        ],
        "page_index": 1,
        "page_size": 1,
        "total_pages": 3,
        "total_records": 3
    }
}

1.6. 对象绑定显示板

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
object_id 是 string 对象编号uid
dashboard_id 是 json 显示板编号列表：[“demo”]

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

{
    "action": "bind_object_dashboard",
    "object_id":"demo",
    "dashboard_id": ["DSH18915024700782"]
}

响应示例：

{
    "resp": "bind_object_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {}
}

1.7. 创建客户

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 客户唯一编号，不填则系统自动生成
name 是 string 客户名称
description 否 string 描述
email 否 string 电子邮箱
contact 否 string 联系人
mobile 否 string 手机号码
phone 否 string 电话号码
province 否 string 省份
city 否 string 城市
address 否 string 详细地址
secret 否 string 授权码，不填则系统生成
responsible 否 string 责任人
responsible_phone 否 string 责任人电话

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
uid string 返回唯一编号

请求示例：

{
    "action": "create_customer",
    "uid": "",
    "name": "mixlinker",
    "description": "无",
    "email": "mix@mixlinker.com",
    "contact": "mix",
    "mobile": "13800138000",
    "phone": "075523746592",
    "province": "广东省",
    "city": "深圳市",
    "address": "",
    "secret": "",
    "responsible": "mix",
    "responsible_phone": ""
}

响应示例：

{
    "resp": "create_customer",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

1.8. 更新客户

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
id 是 int 表自增编号
uid 是 string 客户唯一编号
name 是 string 客户名称
description 否 string 描述
email 否 string 电子邮箱
contact 否 string 联系人
mobile 否 string 手机号码
phone 否 string 电话号码
province 否 string 省份
city 否 string 城市
address 否 string 详细地址
secret 否 string 授权码
responsible 否 string 责任人
responsible_phone 否 string 责任人电话

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
uid string 唯一编号

请求示例：

{
    "action": "update_customer",
    "id": 744,
    "uid": "CST18414161600744",
    "name": "mixlinker",
    "description": "无",
    "email": "mix@mixlinker.com",
    "contact": "mix",
    "mobile": "13800138000",
    "phone": "075523746592",
    "province": "广东省",
    "city": "深圳市",
    "address": "",
    "secret": "",
    "responsible": "mix",
    "responsible_phone": ""
}

响应示例：

{
    "resp": "update_customer",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

1.9. 删除客户

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
uid string 唯一编号

请求示例：

{
    "action": "delete_customer",
    "uid": "CST18414161600744"
}

响应示例：

{
    "resp": "delete_customer",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

1.10. 获取客户详情

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
id int 表自增编号
uid string 客户唯一编号
name string 客户名称
description string 描述
email string 电子邮箱
contact string 联系人
mobile string 手机号码
phone string 电话号码
province string 省份
city string 城市
address string 详细地址
secret string 授权码
responsible string 责任人
responsible_phone string 责任人电话
created int 创建时间
last_modified int 更新时间
is_available int 是否有效

请求示例：

{
    "action": "get_customer_item",
    "uid": "CST18414161600744"
}

响应示例：

{
    "resp": "get_customer_item",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

1.11. 获取客户列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
page_index 否 int 页数
page_size 否 int 每页数量
where_and 否 json and查询条件
where_or 否 json or查询条件时间
where_in 否 json in查询条件

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result参数字段：

参数名称 数据类型 描述
id int 表自增编号
uid string 客户唯一编号
name string 客户名称
description string 描述
email string 电子邮箱
contact string 联系人
mobile string 手机号码
phone string 电话号码
province string 省份
city string 城市
address string 详细地址
secret string 授权码
responsible string 责任人
responsible_phone string 责任人电话
created int 创建时间
last_modified int 更新时间
is_available int 是否有效

请求示例：

{
    "action": "get_customer_list",
    "page_index": 1,
    "page_size": 1,
    "where_and": [["name","like","%mix%"]],
    "where_or": [["name","like","%%"]]
}

响应示例：

{
    "resp": "get_customer_list",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "data": [
            {
                "id": 744,
                "uid": "CST18414161600744",
                "name": "mixlinker",
                "description": "无",
                "email": "mix@mixlinker.com",
                "contact": "mix",
                "mobile": "13800138000",
                "phone": "075523746592",
                "province": "广东省",
                "city": "深圳市",
                "address": "无",
                "secret": "mO3V",
                "responsible": "mix",
                "responsible_phone": "",
                "reference": "",
                "created": "2021-08-24 14:16:16",
                "last_modified": "2021-08-24 14:16:16"
            }
        ],
        "page_index": 1,
        "page_size": 1,
        "total_pages": 1,
        "total_records": 1
    }
}
文档更新时间: 2024-04-12 17:57   作者：技术支持