联系方式
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。
创建联系方式
sofa.apigateway.contact.create 用于创建一个联系方式。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | ContactInfoVO | 是 | param | |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ContactInfoVO | - | data |
代码示例
请求示例
{
"param":{
"name":"kk",
"company":"ant",
"tel":"12345678",
"mail":"123@456.com",
"auth_app_info_id":"oxLIMO8MKn7x6nxy"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo",
"mail":"123@456.com",
"auth_app_info_id":"oxLIMO8MKn7x6nxy",
"name":"kk",
"tel":"12345678",
"company":"ant",
"contact_id":"G2Vbw8Y8eXORnJYc"
},
"result_code":"OK"
}删除联系方式
sofa.apigateway.contact.delete 用于删除一个联系方式。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
contact_id | STRING | 是 | contact_id1 | 联系方式标识 |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | BOOLEAN | true, false | data |
代码示例
请求示例
{
"contact_id":"qwmtenkwcnmeysvd",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":false,
"result_code":"OK"
}更新联系方式
sofa.apigateway.contact.update 用于更新一个联系方式。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | ContactInfoVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | BOOLEAN | - | data |
代码示例
请求示例
{
"param":{
"mail":"123@lvk.com",
"contact_id":"iebxpwp3ipl9gmtu",
"name":"zhuowei",
"auth_app_info_id":"oxLIMO8MKn7x6nxy",
"tel":"1533242",
"company":"seu"
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":true,
"result_code":"OK"
}通过 ID 查询联系方式
sofa.apigateway.contact.get 用于查询并获取指定联系方式的详细信息。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
contact_id | STRING | 是 | contact_id1 | 联系方式标识 |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ContactInfoVO | - | data |
代码示例
请求示例
{
"contact_id":"iebxpwp3ipl9gmtu",
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo",
"mail":"123@lvk.com",
"auth_app_info_id":"oxLIMO8MKn7x6nxy",
"name":"zhuowei",
"tel":"1533242",
"company":"seu",
"contact_id":"iebxpwp3ipl9gmtu"
},
"result_code":"OK"
}查询联系方式分页列表
sofa.apigateway.contact.list 用于查询联系方式的分页列表。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
param | ContactInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ContactInfoPagedListVO | - | data |
代码示例
请求示例
{
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"mail":"123@lvk.com",
"contactId":"iebxpwp3ipl9gmtu",
"name":"zhuowei",
"authAppInfoId":"oxLIMO8MKn7x6nxy",
"tenantId":"JADDGOCN",
"tel":"1533242",
"company":"seu",
"workspaceId":"antdemo"
},
{
"mail":"123@456.com",
"contactId":"G2Vbw8Y8eXORnJYc",
"name":"kk159",
"authAppInfoId":"oxLIMO8MKn7x6nxy",
"tenantId":"JADDGOCN",
"tel":"12345678",
"company":"ant",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}通过授权应用 ID 查询联系方式列表
sofa.apigateway.contact.authapp.list 用于查询指定授权应用的所有联系方式列表。
请求参数
名称 | 类型 | 是否必填 | 示例 | 描述 |
auth_app_info_id | STRING | 是 | a0VIPBXUI4rc25gR | 授权应用 ID |
param | ContactInfoQueryVO | 否 | - | param |
tenant_id | STRING | 是 | TSCPDICNT | 租户标识 |
workspace_id | STRING | 是 | default | 工作空间标识 |
返回参数
名称 | 类型 | 示例 | 描述 |
data | ContactInfoPagedListVO | - | data |
代码示例
请求示例
{
"auth_app_info_id":"hg42jDqSYGREHHKN",
"param":{
"page_info":{
"page_index":1,
"page_size":10
},
"query":{}
},
"tenant_id":"JADDGOCN",
"workspace_id":"antdemo"
}返回示例
{
"data":{
"page_info":{
"total":2,
"page_index":1,
"page_size":10
},
"list":[
{
"mail":"zhuoyu.cq@123.com",
"contactId":"rnE8hd4Tg2GGOcYa",
"name":"zhuoyu",
"authAppInfoId":"BzZy3T82r2vr2Jj4",
"tenantId":"JADDGOCN",
"tel":"12345678",
"company":"seu",
"workspaceId":"antdemo"
},
{
"mail":"123@lvk.com",
"contactId":"iebxpwp3ipl9gmtu",
"name":"zhuowei",
"authAppInfoId":"oxLIMO8MKn7x6nxy",
"tenantId":"JADDGOCN",
"tel":"1533242",
"company":"seu",
"workspaceId":"antdemo"
}
]
},
"result_code":"OK"
}