OpenAPI概览
此文档适用于CloudCC One版本的OpenAPI接口。要查看当前系统版本,请登录系统web应用,进入设置-常规-公司信息,查看当前程序版本。
本文的服务名和参数名第一个字母为小写。word中默认设置单词第一个字母为大写。如有大写,请改成小写。
CloudCC Web服务系统通过http请求提供Web服务,服务数据以json格式进行传输。
CloudCC Web 服务系统采用UTF-8的编码方式传输数据。
请求的URL中如有特殊字符,请用URL编码转换。例如【%】,转换方法为java.net.URLEncoder.encode("%", "UTF-8")。
1.接口联调说明
1.1 Request Details
通过get请求CloudCC 公有云官方开发者地址接口:
https://developer.apis.cloudcc.cn/oauth/apidomain?scope=cloudccCRM&orgId=******(组织id) |
拿到对应的组织api网关地址。例如:
{
"result":true,
"returnInfo":"",
"returnCode":"1",
"orgapi_address":"https://xxxx.apis.cloudcc.cn/lightningapi"
}1.2 请求鉴权获取accessToken
请求接口地址:(Post方式)/api/cauth/token传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| username | 用户名 | string | 必须登录的用户名 |
| safetyMark | 安全标记(系统重置安全标记邮箱获取) | string | 必须获取方式:个人信息-重置我的安全标记 |
| clientId | 注册时获取的clientId | string | 必须获取方式:管理设置-安全性控制-连接的应用程序 |
| secretKey | 注册时获取的secretKey | string | 必须获取方式:管理设置-安全性控制-连接的应用程序 |
| orgId | 组织id | string | 必须 |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | |
| returnCode | 返回编码 | string | |
| data | data存储返回对应信息,包含accessToken | json | |
| accessToken | data中子数据,调接口用 | string | 用于调用cloudccapi鉴权 |
2. Rest API接口
请求方式:post返回接口参数定义中returnCode代码说明:
| 代码值 | 代码说明 | 备注 |
|---|---|---|
| 1 | 调用接口成功 | 没有出现系统接口异常 |
| -1 | 调用接口成功但接口出现异常 | 例如传的参数不正确导致的异常 |
| -2 | 调用接口不成功 | 例如失效 |
| -3 | 参数输入有误 | 比如缺少查询条件 |
2.1 调用接口示例
以普通查询服务cquery为例:
- 服务地址:/openApi/common
- 请求服务名:cquery
- 请求参数类型:application/json
- 请求头:
- 参数名称:accessToken;
- 参数值:登陆接口获取的accessToken
入参示例:
{
"serviceName": "cquery",
"objectApiName": "Contact",
"expressions": "name='13213'",
"isAddDelete": "false",
"fiel
ds":"name,createdate,createbyid"
}回参示例:
{
"result":true,
"returnInfo":"",
"returnCode":"1",
"data":[
{
"CCObjectAPI":"Contact",
"name":"13213",
"createdate":"2021-07-31 00:45:02",
"id":"003202100BDF459HcI1R",
"createbyid":"0052021103B4B6B4Kd02",
"createbyidccname":null
},
{
"CCObjectAPI":"Contact",
"name":"13213",
"createdate":"2021-08-24 22:03:20",
"id":"0032021B4EBE055owhtZ",
"createbyid":"0052021103B4B6B4Kd02",
"createbyidccname":null
}
]
}2.2 accessToken验证服务
2.2.1 验证登录标识(accessToken)是否有效
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:isValidWithBinding
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
2.3 查询服务
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.3.1 普通查询服务
- 请求服务地址:/openApi/common
- 请求服务名:cquery
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| expressions | 查询条件 | string | |
| isAddDelete | 返回数据中是否有已删除的数据,不是必须参数。 | string | true:包含删除的数据 false:不包含 |
| fields | 字段api | string | 多个字段api已英文逗号进行分割(如 name,beizhu,email) |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
2.3.2 带权限的普通查询服务
- 请求服务地址:/openApi/common
- 请求服务名:cqueryWithRoleRight
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| expressions | 查询条件 | string | |
| isAddDelete | 返回数据中是否有已删除的数据,不是必须参数 | string | true:包含删除的数据 false:不包含 |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
2.3.3 分页查询服务
- 请求服务地址:/openApi/common
- 请求服务名:pageQuery
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| fields | 查询的字段 | string | 可不填,如id,name |
| expressions | 查询条件 | string | |
| pageNUM | 当前页数 | int | |
| pageSize | 每页显示的数目 | int |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
| pageNUM | 当前页数 | int | |
| pageSize | 每页显示的数目 | int | |
| totalCount | 共多少条记录 | long | |
| pageCount | 共多少页 | int | |
| hasPre | 上一页 | boolean | ture/false |
| hasNext | 下一页 | boolean | true/false |
2.3.4 带权限的分页查询服务
- 请求服务地址:/openApi/common
- 请求服务名:pageQueryWithRoleRight
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| fields | 查询的字段 | String | 可不填如id_name |
| expressions | 查询条件 | string | |
| pageNUM | 当前页数 | int | |
| pageSize | 每页显示的数目 | int |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
| pageNUM | 当前页数 | int | |
| pageSize | 每页显示的数目 | int | |
| totalCount | 共多少条记录 | long | |
| pageCount | 共多少页 | int | |
| hasPre | 上一页 | boolean | true/false |
| hasNext | 下一页 | boolean | true/false |
2.3.5 获取对象查询权限
- 请求服务地址:/openApi/common
- 请求服务名:getQueryPermisson
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名,可传入多个对象以英文逗号分隔 | string |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
| apiName | 对象名 | string | |
| query | 是否有查看权限 | string | true:有查看权限 false:没有查看权限 |
| shareSql | 查询权限SQL | string | 当没有查看权限或者有查看全部记录权限时值为空 |
CCService使用方法:List<Map> list= this.getQueryPermisson("Account,Opportunity") ;
2.3.6 自定义SQL查询(含配置权限控制)
- 请求服务地址:/openApi/common
- 请求服务名:cqlQueryWithLogInfo
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| expressions | 查询SQL | string | 查询字段包含大小写下划线需要加别名,则返回信息与别名保持一致 |
expressions参数示例: select id,name,Account__c as Account__c from cloudcclead返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
配置所有用户可用:cloudcc.cchttp.cqlquery.enable.profileid=all,也可将all换成有权限使用的简档ID 以逗号分割
CCService使用方法:
List<CCObject> list= this.cqlQueryWithLogInfo("Account","select id ,name,lead_c as lead_c from Account where id='001aaaaabbbbbccdddd' ",null)2.3.7 静态查询接口
- 请求服务地址:/openApi/common
- 请求服务名:cqlQueryWithStatic
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| expressions | 查询SQL | string | 查询字段包含大小写下划线需要加别名,则返回信息与别名保持一致 |
| nextRecordQueryId | 第一次查询返回的id | String | 第二次查询需要传入查询id,除serviceName和accessToken外其他参数可以不传 |
expressions参数示例: select id,name,Account__c as Account__c from cloudcclead返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
| nextRecordQueryId | 第一次查询返回的查询id | String |
配置所有用户可用:cloudcc.cchttp.cqlquery.enable.profileid=all,也可将all换成有权限使用的简档ID 以逗号分割
CCService使用方法:
List<CCObject> list= this.cqlQueryWithLogInfo("Account","select id ,name,lead_c as lead_c from Account where id='001aaaaabbbbbccdddd' ",null) ;2.4 插入服务
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.4.1 普通插入服务
- 请求服务地址:/openApi/common
- 请求服务名:insert
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 插入数据 | string | json |
data数据格式:
[{key3:value3, key2:value2, key1:value1}, {key11:value11, key22:value22, key33:value33}]返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | |
| returnCode | 返回编码 | string | |
| data | 返回相关数据 | json | 含有插入数据的ID值 |
2.4.2 带权限的插入服务
- 请求服务地址:/openApi/common
- 请求服务名:insertWithRoleRight
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| Data | 插入数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | |
| returnCode | 返回编码 | String | |
| data | 返回相关数据 | json | 含有插入数据的ID值 |
2.5 删除服务
- 请求服务地址:/openApi/common
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.5.1 普通删除服务
- 请求服务地址:/openApi/common
- 请求服务名:delete
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 删除数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
2.5.2 带权限的删除服务
- 请求服务地址:/openApi/common
- 请求服务名:deleteWithRoleRight
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 删除数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
2.6 修改服务
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.6.1 普通修改服务
- 请求服务地址:/openApi/common
- 请求服务名:update
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 修改数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
2.6.2 带权限的修改服务
- 请求服务地址:/openApi/common
- 请求服务名:updateWithRoleRight
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 修改数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
2.7 插入或者修改数据服务
- 请求方式:post
- 入参数据类型:json
2.7.1 普通插入或者修改数据服务
- 请求服务地址:/openApi/common
- 请求服务名:upsert
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 插入数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | |
| returnCode | 返回编码 | string | |
| data | 返回相关数据 | json | 含有插入数据的ID值 |
添加一条数据和多条数据是一样的服务。
data可以是一条数据,或者数据集合。
data为JSONArray 字符串,数据格式必须以“[”开头。
data数据格式:[{key3:value3, key2:value2, key1:value1}, {key11:value11, key22:value22, key33:value33}]
2.7.2 带权限的插入或者修改数据服务
- 请求服务地址:/openApi/common
- 请求服务名:upsertWithRoleRight
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 插入数据 | string | json |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | |
| returnCode | 返回编码 | string | |
| data | 返回相关数据 | json | 含有插入数据的ID值 |
添加一条数据和多条数据是一样的服务
data可以是一条数据,或者数据集合。
data为JSONArray 字符串,数据格式必须以“[”开头。
data数据格式:[{key3:value3, key2:value2, key1:value1}, {key11:value11, key22:value22, key33:value33}]
2.8 自助服务接口
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:customService
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| objectApiName | 对象名 | string | |
| data | 数据 | string | json |
| objectType | 对象类型 | string | standard/custom/temp |
| operateType | 操作类型 | string | insert/query/update/delete/queryCompare/queryMsg |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | 查询 |
修改一条数据和多条数据是一样的服务,
data可以是一条数据,或者数据集合。
1. 当operateType= queryCompare时,查询条件中可以包含>、>=、<、<=、!=、=符号的查询条件。
2. 查询条件放在data参数中,data参数为数据集合。
3. age>30条件的书写方式:
data=[{“field”:”age”,”operator”:”$gt”,”value”:30}]。
4. age>=30条件的书写方式:
data=[{“field”:”age”,”operator”:”$gte”,”value”:30}]。
5. age<40条件的书写方式:
data=[{“field”:”age”,”operator”:”$lt”,”value”:40}]。
6. age<=40条件的书写方式:
data=[{“field”:”age”,”operator”:”$lte”,”value”:40}]。
7. age=40条件的书写方式:
data=[{“field”:”age”,”operator”:”dy”,”value”:40}]。
8. age!=40条件的书写方式:
data=[{“field”:”age”,”operator”:”$ne”,”value”:40}]。
9. age>=30 and age<=40复合条件查询:
data=[{“field”:”age”,”operator”:”$gte”,”value”:30},{“field”:”age”,”operator”:”$lte”,”value”:40}]
2.8.1 操作类型insert
请参考自助服务接口,无特别说明。
2.8.2 操作类型query
请先参考自助服务接口,此处说明的参数为可选参数,
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| limit | 查询的数据量 | string | limit 和 orderby 需同时设置 |
| orderby | 排序字段 | string | limit 和 orderby 需同时设置 |
| upOrDown | 升序OR降序 | string | 参数值:up / down |
| skipNum | 跳过的数据量 | string | |
| operateResult | 是否处理结果 | string | 参数值为1时:不处理查询的结果数据。当参数值为空或url中没有此参数时,处理查询的结果数据。 |
2.8.3 操作类型update
请先参考自助服务接口,此处说明data参数数据结构和update专用参数。
data参数数据结构
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| updateCondition | 更新的条件 | json | |
| updateValue | 更新的信息 | Json | 此处填写全部集合参数,不能只填写需要更新的元素。原因为只填写需要更新的元素,其余元素会被删除。 |
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| isUpsert | 在没有更新数据时,是否插入数据 | string | true/false 默认为 false |
| isMuti | 是否更新多条数据 | string | true/false 默认为 false |
2.8.4 操作类型delete
请参考自助服务接口,无特别说明。
2.8.5 操作类型queryCompare
请参考自动服务接口和操作类型query 说明
2.8.6 操作类型queryMsg
queryMsg先调用query接口查询数据,然后调用delete接口删除查询的数据。queryMsg接口返回query接口查询的数据。此接口请慎用,容易误删数据。
2.9 发送手机消息服务
- 请求方式:post
- 入参数据类型:json
2.9.1 手机消息服务
- 请求服务地址:/openApi/common
- 请求服务名:telMessage
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| phoneNum | 接收短信手机号 | 多个手机号码用“,”隔开 | |
| content | 内容 | ||
| apiCode | 短信模板API代码 | ||
| templateStr | 模板变量 | string |
2.10 图片服务
- 请求方式:post
2.10.1 图片上传服务
- 请求服务地址:/openApi/file
- 请求服务名:uploadImg
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| imgName | 图片名 | string | |
| imgType | 图片格式 | string | jpg/bmp/png |
| imgWidth | 图片宽度 | int | 单位:px |
| imgHeight | 图片高度 | int | 单位:px |
| imgId | 图片ID | string | 为空时添加图片,不为空时修改图片。为空时data要有此属性,imgId:null/imgId: "" |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json | json字符串 |
返回接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| imgId | 图片ID | string |
2.10.2 多张图片上传服务
- 请求服务地址:/openApi/file
- 请求服务名:uploadImgMany
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json | json字符串 |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须/备注 |
|---|---|---|---|
| imgName | 图片名 | string | 是 |
| imgType | 图片格式 | string | 是;jpg/bmp/png |
| imgWidth | 图片宽度 | int | 否;单位:px;参数值为空时为图片原始大小。 |
| imgHeight | 图片高度 | int | 否;单位:px;参数值为空时为图片原始大小。 |
| imgId | 图片ID | string | 否;为空时添加图片,不为空时修改图片。 |
| longitude | 经度 | double | |
| latitude | 维度 | double | |
| address | 地理位置 | string |
data数据格式:[{\"imgName\":\"imgName\",\"imgType\":\"png\",\"imgWidth\":\"\",\"imgHeight\":\"\",\"imgId\":\"\"},{\"imgName\":\"imgName\",\"imgType\":\"png\",\"imgWidth\":\"\",\"imgHeight\":\"\",\"imgId\":\"\"}]
返回接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| imgId | 图片ID | string |
2.10.3 获取图片属性
- 请求服务地址:/openApi/common
- 请求服务名:getImgProperty
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| serviceName | 请求服务名 | string | 是 |
| data | 消息数据,json格式字符串 | string | 是 |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json | json字符串 |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| imgId | 图片ID | string | 是 |
1、一次可查询一个或多个图片的属性。
2、data数据格式:[{"imgId":"1405064444691bny9gk1h!4fc6067f917f39da72e9b156063b4d6e"},{"imgId":"1405064444722VRufgUib!4fc6067f917f39da72e9b156063b4d6e"}]
2.11 文件上传服务(文件流方式)
- 请求服务地址:/openApi/file
- 请求方式:post
- 入参数据类型:formdata
- 请求服务名:uploadFile
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| relatedId | 文件关联的记录ID | string | |
| fileName | 文件名 | String | |
| suffix | 后缀名 | String |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json | json字符串 |
返回接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| fileId | 文件ID | string |
2.12 文件上传服务(base64方式)
- 请求服务地址:/openApi/common
- 请求服务名:uploadAttachement
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | uploadAttachement | string | |
| recordId | 父记录id | string | |
| fileName | 文件名称,带文件格式后缀 | String | |
| fileData | 文件内容,base64格式 | String |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json |
2.13 文件下载服务
- 请求服务地址:/openApi/downloadFile
- 请求方式:Get
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| accessToken | 身份认证 accessToken | string | |
| id | 文件ID | string | 手动获取 |
返回结果:以二进制流的形式返回文件,文件在InputStream里面
2.14 文件下载服务(base64格式)
- 请求服务地址:/openApi/common
- 请求服务名:downloadAttachement
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | downloadAttachement | string | |
| id | 文件id | string |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json |
2.15 删除附件
- 请求服务地址:/openApi/common
- 请求服务名:deleteAttachment
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | deleteAttachment | string | |
| id | 附件id | string | |
| isDeleteFile | 是否删除文件 | string | true/false |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json |
2.16 删除文件
- 请求服务地址:/openApi/common
- 请求服务名:deleteFile
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | deleteFile | string | |
| id | 文件id | string |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | json |
2.17 发送邮件服务
- 请求服务地址:/openApi/common
- 请求方式:post
- 入参数据类型:json
- 请求服务名:sendEmail
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| toAddress | 收件人 | 多个邮件地址用“,”隔开 | |
| ccAddress | 抄送人 | 多个邮件地址用“,”隔开 | |
| bccAddress | 密送人 | 多个邮件地址用“,”隔开 | |
| subject | 主题 | ||
| content | 内容 | ||
| isText | 是否采用TXT方式发送 | true/false | |
| apiCode | 邮件模板API代码 | ||
| templateStr | 模板变量 | string |
举例:邮件模板中的内容为um,您好!欢迎使用QR房管家邮箱绑定服务,验证码为:code,请在time分钟内进行验证。templateStr=um_小李,code_0000,time_30
2.18 chatter接口
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.18.1 获取chatter内容
- 请求服务地址:/openApi/common
- 请求服务名:getChatters01
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| queryType | 查询类型 | string | |
| userId | 用户ID | string | |
| feedId | 微贴ID | string | |
| recordId | 记录ID | string | |
| feedSort | 排序字段 | string | |
| limit | 查询限制数 | int | |
| skip | 查询跳过的记录数 | int | |
| targetId | 目标Id | string | 小组ID,人员ID,记录ID |
2.18.2 获取我追随的chatter内容
- 请求服务地址:/openApi/common
- 请求服务名:getMyChatter01
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| feedSort | 排序字段 | string | |
| limit | 查询限制数 | int | 不能为0 |
| skip | 查询跳过的记录数 | int |
2.18.3 查询用户的追随者,以及被用户追随的人员
- 请求服务地址:/openApi/common
- 请求服务名:getFollowUsers
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| userId | 用户ID | string | |
| followType | 追随类别 | string | followme/mefollow/allow |
2.18.4 查询追随对象记录的人员
- 请求服务地址:/openApi/common
- 请求服务名:getRecordFollowUsers
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| recordId | 对象记录ID | string | 对象信息的记录 ID号 例如业务机会的记录ID号 |
2.18.5 查询微贴用户信息
- 请求服务地址:/openApi/common
- 请求服务名:getUserMapByIds
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| userIds | 用户ID集合 | string | 多个用户ID用","分隔 |
2.18.6 发布普通类型的帖子
- 请求服务地址:/openApi/common
- 请求服务名:addMicroPostF
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| body | 帖子的内容 | string | |
| targetType | 帖子的目标类型,可以为空,默认为follower | string | |
| targetId | 目标id | ||
| recordId | 记录id | ||
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
| taskIdOrEventId | 任务或者事件ID | string | 否 |
2.18.7 发布文件类型的帖子
- 请求服务地址:/openApi/common
- 请求服务名:addMicroPostD
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| fileName | 文件名称 | string | |
| fileType | 文件类型 | string | |
| fileData | 文件内,Base64编码,Base64.NO_WRAP | string | |
| body | 帖子内容 | string | |
| targetType | 帖子的目标类型,默认为follower | string | |
| targetId | 目标ID | string | |
| recordId | 记录ID | string | |
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
| taskIdOrEventId | 任务或者事件ID | string | 否 |
2.18.8 发布多个文件类型的帖子
- 请求服务地址:/openApi/common
- 请求服务名:addMicroPostDMany
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| serviceName | 请求服务名 | string | 是 |
| data | 消息数据,json格式 | string | 是 |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| body | 帖子内容 | string | 否 |
| targetType | 帖子的目标类型,默认为follower | string | 否 |
| targetId | 目标ID | string | 否 |
| recordId | 记录ID | string | 否 |
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
| fileIds | 文件ID | string | 是 |
| taskIdOrEventId | 任务或者事件ID | string | 否 |
文件ID集合为多张图片上传服务返回的文件ID信息。fields:"1406267040275C3JQNHha!4fc6067f917f39da72e9b156063b4d6e","14062670400259idTKjoi!4fc6067f917f39da72e9b156063b4d6e"fields文件ID,多个文件ID用“,”分隔。
2.18.9 发布链接类型的帖子
- 请求服务地址:/openApi/common
- 请求服务名:addMicroPostL
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| linkName | 链接名称 | string | |
| linkValue | 链接 | string | |
| body | 帖子内容 | string | |
| targetType | 帖子的目标类型 | string | 默认为follower |
| targetId | 目标ID | string | |
| recordId | 记录ID | string | |
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
| taskIdOrEventId | 任务或者事件ID | string | 否 |
ØParameters:
queryType: 查询类型
me: 表示涉及我的帖子
zone :chatter空间显示的帖子
mark: 收藏的帖子
findone: 查询单个的帖子,这种情况下,feedid不能为空
record: 查询相关记录下的帖子,这种情况下,recordId不能为空
userId: 用户Id,如果为空,默认为当前登录用户的id
feedid: 微贴的id,用于findone类型的查询中
recordId: 相关记录的id,用于record类型的查询中
feedsort: 排序字段(lastModifyDate, createDate),默认为lastModifyDate
limit: 查询限制数
skip: 查询跳过的记录数
2.18.10 发布投票类型的帖子
- 请求服务地址:/openApi/common
- 请求服务名:addMicroPostV
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| pollOptions | 投票选项 | string | json格式字符串: [{"option":"选项1"}, {"option":"选项2"}]; 至少有两个选项。选项的先后顺序是json item的顺序。 |
| body | 帖子内容 | string | |
| targetType | 帖子的目标类型 | string | 默认为follower |
| targetId | 目标ID | string | |
| recordId | 记录ID | string | |
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
| taskIdOrEventId | 任务或者事件ID | string | 否 |
2.18.11 投票接口
- 请求服务地址:/openApi/common
- 请求服务名:voteMicroPost
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| feedId | 帖子ID | string | 是 |
| option | 投票选项 | string | 是 |
2.18.12 发布带文件的评论
- 请求服务地址:/openApi/common
- 请求服务名:addMicroCommentFile
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| feedId | 微帖ID | string | |
| Filename | 文件名称 | string | |
| body | 帖子内容 | string | |
| fileType | 文件类型 | string | |
| fileData | 文件内容。Base64编码,Base64.NO_WRAP | string | |
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
2.18.13 发布普通的评论
- 请求服务地址:/openApi/common
- 请求服务名:addMicroComment
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| feedId | 微帖ID | string | |
| body | 帖子内容 | string | |
| longitude | 经度 | double | 否 |
| latitude | 纬度 | double | 否 |
| address | 地址 | string | 否 |
2.18.14 喜欢或取消喜欢帖子
- 请求服务地址:/openApi/common
- 请求服务名:praiseFeed
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| feedId | 微帖ID | string | |
| likeOrDislike | 喜欢/取消喜欢 | string | -1表示取消喜欢,1表示喜欢帖子 |
2.18.15 喜欢或取消喜欢评论
- 请求服务地址:/openApi/common
- 请求服务名:praiseComment
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| commentId | 评论ID | string | |
| likeOrDislike | 喜欢/取消喜欢 | string | -1表示取消喜欢,1表示喜欢帖子 |
| feedId | 微帖ID | string |
2.18.16 收藏或取消收藏帖子
- 请求服务地址:/openApi/common
- 请求服务名:favoriteFeed
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| feedId | 微贴ID | string | |
| favoriteOrUnfavorite | 收藏/取消收藏 | string | -1表示取消收藏,1表示收藏 |
2.18.17 删除帖子
- 请求服务地址:/openApi/common
- 请求服务名:removeMicroPost
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| feedId | 微贴ID | string |
2.18.18 删除评论
- 请求服务地址:/openApi/common
- 请求服务名:removeMicroComment
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| commentId | 评论ID | string |
2.18.19 追随或取消追随操作
- 请求服务地址:/openApi/common
- 请求服务名:operateFollowRelation
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| followType | 追随类型 | string | record或people |
| parentId | 用户Id或记录Id | string | |
| followStatus | 追随状态 | string | 0表示取消追随,1表示追随人员或是记录 |
2.18.20 查询人员信息
- 请求服务地址:/openApi/common
- 请求服务名:getChatterUserInfo
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| userId | 用户ID | string | 否 |
| feedSort | 排序字段 | string | 否 |
| limit | 查询限制数 | int | 否 |
| skip | 查询跳过的记录数 | int | 否 |
| isReturnChatter | true/false,是否返回查询人员发布的chatter信息,默认为false | string | 否 |
2.18.21 修改人员信息
- 请求服务地址:/openApi/common
- 请求服务名:updateChatterUserInfo
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| 电子邮件 | string | ||
| fax | 传真 | string | |
| phone | 联系电话 | String | |
| mobile | 手机 | string | |
| aboutme | 关于我 | string | |
| country | 国家 | string | |
| address | 联系地址 | string | |
| postalcode | 邮编 | string | |
| title | 职位 | string | |
| imgStr | 头像 | string | Base64编码, Base64_NO_WRAP |
2.18.22 下载与Chatter相关的文件
- 请求服务地址:/openApi/common
- 请求服务名:downloadFileChatter
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| fileId | 文件所在记录ID | string |
返回结果:以二进制流的形式返回文件,文件在InputStream里面
2.18.23 查询用户组接口
- 请求服务地址:/openApi/common
- 请求服务名:getGroupInfo
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 是否必须 |
|---|---|---|---|
| queryType | 用户组查询类型:我的组(my);全部组(all);默认为my | string | 否 |
| limit | 查询限制数 | int | 否 |
| pageNUM | 当前页数 | int | 否 |
| queryConGroupName | 根据用户组名查询用户组信息 | string | 否 |
| sortField | 排序的字段 | string | 否 |
| sortValue | 排序值:1:升序;-1:降序。默认为-1。 | string | 否 |
2.19 查询选项列表字段选项值
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:getPickListValue
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| objectApiName | 对象API名称 | string | |
| fieldApi | 字段API名称 | string | |
| recordType | 记录类型ID | string |
2.20 选项列表以及记录类型依赖关系配置
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:saveDependency
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | saveDependency | string | |
| objectApi | 对象API名称 | string | |
| controlFieldApi | 控制字段API名称 | string | 如果是记录类型的话,传recordtype |
| dependencyFieldApi | 被控制字段API名称 | string | |
| defaultVal | 默认值 | string | 记录类型配置默认值 |
| data | 消息数据 | string | json数组 |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| controival | 控制字段选项值 | string | 如果是记录类型,传记录类型id |
| dependencyval | 被控制字段选项值,多个选项用英文逗号分割 | string |
2.21 审批接口
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.21.1 查询待审批项目接口
- 请求服务地址:/openApi/common
- 请求服务名:getApprovalPaddingList
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| userId | 用户ID | string |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
2.21.2 批准接口
- 请求服务地址:/openApi/common
- 请求服务名:doApproved
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| workItemId | 批准请求ID | string | |
| comments | 批准注释 | string | |
| appPath | 应用路径,一般为NULL | string |
2.21.3 拒绝接口
- 请求服务地址:/openApi/common
- 请求服务名:doRejected
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| workItemId | 批准请求ID | string | |
| comments | 批准注释 | string | |
| appPath | 应用路径,一般为NULL | string |
2.21.4 重新分配接口
- 请求服务地址:/openApi/common
- 请求服务名:doReassign
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| workItemId | 批准请求ID | string | |
| comments | 批准注释 | string | |
| appPath | 应用路径,一般为NULL | string | |
| fprId | 被分配人ID | string |
2.21.5 调回接口
- 请求服务地址:/openApi/common
- 请求服务名:reCall
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| related | 相关记录ID | string | |
| comments | 注释说明 | string |
2.21.6 提交审批接口
- 请求服务地址:/openApi/common
- 请求服务名:submitForApproval
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| data | 消息数据 | string | json |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
传入接口参数data数据定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| related | 相关记录ID | string | |
| appPath | 应用路径,一般为NULL | string | |
| fprId | 被分配人ID | string | |
| comments | 提交审批备注信息 | string | |
| approvalApi | 批准过程唯一名称 | string | |
| skipEntryCriteria | 是否跳过条件验证 | string | true/false |
2.22 获取应用程序接口
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:getAppList
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
2.23 获取选项卡接口
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:getAllTabs
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | |
| appId | 应用程序ID | string | 可以为空,为空时查询全部选项卡信息。 |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
2.24 获取应用程序和选项卡接口
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:getAppAndTabList
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string |
返回接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | boolean | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回数据 | string | json |
2.25 获取搜索设置接口
- 请求方式:post
- 入参数据类型:json
- 请求服务地址:/openApi/common
- 请求服务名:getMySetupObjs
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据 | string | json |
2.26 新建用户接口
- 请求方式:post
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 入参数据类型:json
2.26.1 获取角色信息接口
- 请求服务地址:/openApi/common
- 请求服务名:searchRole
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 传入接口参数定义:
- 返回接口参数:
2.26.2 获取简档信息接口
- 请求服务地址:/openApi/common
- 请求服务名:searchProfile
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 传入接口参数定义:
- 返回接口参数:
2.26.3 新建用户接口
- 请求服务地址:/openApi/common
- 请求服务名:createUser
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 传入接口参数定义:
- 返回接口参数:
2.26.4 获取用户头像信息接口
- 请求服务地址:/openApi/user/getPhotos
- 请求方式:POST
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
- 传入接口参数定义:
- 返回接口参数:
2.26.5 展示用户头像接口
- 请求服务地址:/api/user/userPhoto
- 请求方式:GET
- 请求头:
- 参数名称:accessToken
- 参数值:登陆接口获取的accessToken
传入接口参数定义:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| id | 用户id | string | 不填时默认为登录人 |
返回接口参数:
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
3.接口操作示例
3.1 通过get请求CloudCC 公有云官方开发者地址接口
https://developer.apis.cloudcc.cn/oauth/apidomain?scope=cloudccCRM&orgId=******(组织id) |
拿到对应的组织api网关地址。例如:
{
"result":true,
"returnInfo":"",
"returnCode":"1",
"orgapi_address":"https://xxxx.apis.cloudcc.cn/lightningapi"
}示例如下:

3.2 调用上面获得的域名/api/cauth/token 这个接口,进行登陆鉴权,获取到accessToken.
传参示例:
{
"username":"",
"safetyMark":"",
"clientId":"",
"secretKey":"",
"orgId":"",
"grant_type":"password"
}回参示例:
{
"data": {
"accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ2ZXJzaW9uVHlwZSI6IkVudGVycHJpc2UiLCJhdWQiOiJjbG91ZGNjIiwibG9naW5O"
},
"requestId": null,
"returnCode": "1",
"returnInfo": null,
"result": true,
"stackTrace": null,
"errorSQL": null
}| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | 必填 |
| searchValue | 搜索关键字 | string | 不填或为空则获取全部角色信息 |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据,json | string |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | 必填 |
| searchValue | 搜索关键字 | string | 不填或为空则获取全部简档信息 |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据,json | string |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| serviceName | 请求服务名 | string | 必填 |
| loginName | 登录名称 | string | 必填 |
| name | 用户姓名 | string | 必填 |
| 用户电子邮箱 | string | 必填 | |
| profiledd | 简档Id | string | 必填 |
| roleId | 角色Id | string | 必填 |
| password | 密码(MD5加密) | string | 填写则按MD5进行加密,不填则为默认密码111111 |
| sendEmail | 是否邮件通知 | string | 0:不通知,1:通知 |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| id | 用户id | string | 不填时默认为登录人 |
| 参数名称 | 参数说明 | 参数类型 | 备注 |
|---|---|---|---|
| result | 执行结果 | string | true/false |
| returnInfo | 返回信息 | string | 文本 |
| returnCode | 返回编码 | string | |
| data | 返回结果数据, json | string |

3.2.1 安全标记来自于个人设置里的“重置我的安全标记”,会发到当前登录账号的邮箱里。

邮件内容如下:

3.2.2 ClientId和SecretKey,来自于安全性控制里的“连接的应用程序”。


3.3 根据需要调用增删改查接口,地址为:上面获得的接口域名/openApi/common
在请求头中(header)里,放入上面步骤二获得的accessToken
传参以cquery为例:
{
"serviceName": "cquery",
"objectApiName": "Contact",
"expressions": "name=’test11’",
"isAddDelete": "false",
"fields":"name,createdate,createbyid"
}回参示例:
{
"result":true,"returnInfo":"",
"returnCode":"1",
"data":[{"CCObjectAPI":"Contact","name":"test11","createdate":"2021-02-02 11:06:05","id":"00320215C5835B4Lzh8p","createbyid":"005202008F608AAuoER1","createbyidccname":"biys系统管理员"},{"CCObjectAPI":"Contact","name":"test11","createdate":"2022-11-22 12:17:31","id":"003202254DBC0FF90tIf","createbyid":"005202008F608AAuoER1","createbyidccname":"biys系统管理员"}]
}

4.API Limits
SaaS版本的API调用受CloudCC 版本配额限制,On-prem版本除外,具体配额如下:
| 版本 | 允许的次数(每24小时) | 最大限额(每24小时) |
|---|---|---|
| 专业版 | 5000+用户许可数*150 | 10000次 |
| 企业版 | 50000+用户许可数*300 | 200000次 |
| 旗舰版 | 50000+用户许可数*500 | 500000次 |
| 超级版 | 50000+用户许可数*500 | 500000次 |
** 无论何种版本配额,禁止以超过CloudCC并发限制及调用频率对CLoudCC API进行超负荷的请求,如发现有异常违规请求,CloudCC有权对此API Client进行停用。
** 以上配额仅供参考,具体配额会随CLoudCC版本升级及技术架构进行调整,详情请关注CloudCC系统通知。