客户公司接口

获取公司列表

该接口用于一次获取多个客户公司信息

请求方法

GET /organizations

请求参数(Query String)

参数名 必填 类型 说明 限制
query 字符串 查询关键字
page 整型 页码,从1开始,默认为1
per_page 整型 每页数量,默认20,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
organizations 数组 客户公司列表,详见公司数据

示例

curl http://demo.udesk.cn/open_api_v1/organizations?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1 
    },
    "organizations": [
        {
            "id": 1,
            "name": "测试公司1",
            "domains": "http://www.test1.com",
            "custom_fields": {
                "TextField_1": "测试文本",
                "SelectField_1": ["0"]
            },
            "description": "该公司仅用来举例",
            "token": "123456s7hgfd"
        }
    ]
}

获取公司详情

该接口用于获取符合指定条件的客户公司信息

请求方法

GET /organizations/show_org

请求参数(Query String)

参数名 必填 类型 说明 限制
type 字符串 条件类型 不超过255个字符
content 字符串 条件内容 不超过255个字符

type取值范围

取值 含义
id 公司id
name 公司名称
token 公司外部标识

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
organization 对象 客户公司信息,详见公司数据

示例

curl http://demo.udesk.cn/open_api_v1/organizations/show_org?type=name&content=测试公司1&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "organization": {
        "id": 1,
        "name": "测试公司1",
        "domains": "http://www.test1.com",
        "custom_fields": {
            "TextField_1": "测试文本",
            "SelectField_1": ["0"]
        },
        "description": "该公司仅用来举例",
        "token": "123456s7hgfd"
    }
}

获取公司客户列表

该接口用于获取符合指定条件的公司的客户信息

请求方法

GET /organizations/customers

请求参数(Query String)

参数名 必填 类型 说明 限制
type 字符串 条件类型,参见获取公司详情接口 不超过255个字符
content 字符串 条件内容,参见获取公司详情接口 不超过255个字符
page 整型 页码,从1开始,默认为1
page_size 整型 每页数量,默认20,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
customers 数组 客户列表,详见[客户数据][]

示例

curl http://demo.udesk.cn/open_api_v1/organizations/customers?type=id&content=1&page=1&page_size=10&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1 
    },
    "customers": [
        {
            "id": 3,
            "nick_name": "大大1",
            "level": "normal",
            "description": null,
            "tags": [],
            "first_contact_at": null,
            "last_contact_at": null,
            "first_contact_at_via_phone": null,
            "last_contact_at_via_phone": null,
            "first_contact_at_via_im": null,
            "last_contact_at_via_im": null,
            "owner_id": null,
            "owner_group_id": null,
            "custom_fields": {},
            "open_api_token": null,
            "email": "",
            "other_emails": [],
            "organization_id": 1,
            "cellphones": [
                {"id": 5, "content": "12333334444"}
            ],
            "wechat": [],
            "weibo": []
        }
    ]
}

创建公司

该接口用于创建客户公司

请求方法

POST /organizations

请求参数(Request Body)

参数名 类型 必填 说明
organization 对象 公司信息

organization

参数名 类型 必填 说明 限制
name 字符串 名称 不超过255个字符
description 字符串 描述 不超过255个字符
domains 字符串 域名
custom_fields 对象 自定义字段

返回数据

与[获取公司详情][]相同。

示例

curl http://demo.udesk.cn/open_api_v1/organizations?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X POST \
-H 'content-type: application/json' \
-d '
{
    "organization": {
        "name": "测试公司1",
        "description": "测试公司1描述",
        "notes": "",
        "domains": "http://www.test1.com",
        "custom_fields": {
            "TextField_1": "测试文本",
            "SelectField_1": ["0"]
        },
        "token": "123456s7hgfd"
    }
}'

返回

{
    "code": 1000,
    "organization": {
        "id": 1,
        "name": "测试公司1",
        "domains": "http://www.test1.com",
        "created_at": "2015-01-02T15:04:05.000+08:00",
        "token": "123456s7hgfd",
        "custom_fields": {
            "TextField_1": "测试文本",
            "SelectField_1": ["0"]
        },
        "description": "测试公司1描述",
        "customer_count": 0
    }
}

更新公司

该接口用于修改符合指定条件的客户公司

请求方法

PUT /organizations/update_org

请求参数(Query String)

获取公司详情接口相同。

请求参数(Request Body)

参数名 类型 必填 说明
organization 对象 公司信息,参见公司数据

公司的token存在则不可更改,不存在则可修改

返回数据

与[获取公司详情][]相同。

示例

请求

curl http://demo.udesk.cn/open_api_v1/organizations/update_org?type=name&content=测试公司1&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X PUT \
-H 'content-type: application/json' \
-d '
{
    "organization": {
        "description": "测试公司1描述文字",
    }
}'

返回

{
    "code": 1000,
    "organization": {
        "id": 1,
        "name": "测试公司1",
        "domains": "http://www.test1.com",
        "created_at": "2015-01-02T15:04:05.000+08:00",
        "custom_fields": {
            "TextField_1": "测试文本",
            "SelectField_1": ["0"]
        },
        "description": "测试公司1描述文字",
        "token": "123456s7hgfd",
        "customer_count": 0
    }
}

删除公司

该接口用于删除符合指定条件的客户公司

请求方法

DELETE /organizations/destroy_org

请求参数(Query String)

获取公司详情接口相同。

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
id 整型 删除公司的id

示例

curl http://demo.udesk.cn/open_api_v1/organizations/destroy_org?type=name&content=测试公司1&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X DELETE

返回

{
    "code": 1000,
    "id": 1
}

获取公司自定义字段(废弃)

该接口用于获取全部公司自定义字段列表

请求方法

GET /organizations/custom_fields

请求参数

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
custom_fields 数组 公司自定义字段列表,详见公司数据

示例

curl http://demo.udesk.cn/open_api_v1/organizations/custom_fields?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "custom_fields": [
        {
            "id":10,
            "field_name":"TextField_10",
            "field_title":"浏览器",
            "content_type":"text",
            "comment":"",
            "options": null,
            "permission":3,
            "requirment":false
        },
        {
            "id":11,
            "field_name":"SelectField_11",
            "field_title":"及联城市",
            "content_type":"chained_droplist",
            "comment":"内容",
            "options": [{"0":["北京市", [["海淀区", [["知春路"]]]]]}, {"1":["天津市", [["和平区"]]]}],
            "permission":2,
            "requirment":false
        }
    ]
}

数据结构-公司

属性名 类型 可修改 说明
id 整型 唯一标识
name 字符串 名称
domains 字符串 域名
created_at 日期时间 创建时间
custom_fields 对象 自定义字段
description 字符串 描述
customer_count 整型 客户数量
token 字符串 客户公司token