全部产品

联系方式

更新时间:2020-04-21 11:33:52

本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。

创建联系方式

sofa.apigateway.contact.create 用于创建一个联系方式。

请求参数

名称 类型 是否必填 示例 描述
param ContactInfoVO param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data ContactInfoVO - data

代码示例

请求示例

  1. {
  2. "param": {
  3. "name": "kk",
  4. "company": "ant",
  5. "tel": "12345678",
  6. "mail": "123@456.com",
  7. "auth_app_info_id": "oxLIMO8MKn7x6nxy"
  8. },
  9. "tenant_id": "JADDGOCN",
  10. "workspace_id": "antdemo"
  11. }

返回示例

  1. {
  2. "data": {
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo",
  5. "mail": "123@456.com",
  6. "auth_app_info_id": "oxLIMO8MKn7x6nxy",
  7. "name": "kk",
  8. "tel": "12345678",
  9. "company": "ant",
  10. "contact_id": "G2Vbw8Y8eXORnJYc"
  11. },
  12. "result_code": "OK"
  13. }

删除联系方式

sofa.apigateway.contact.delete 用于删除一个联系方式。

请求参数

名称 类型 是否必填 示例 描述
contact_id STRING contact_id1 联系方式标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN true, false data

代码示例

请求示例

  1. {
  2. "contact_id": "qwmtenkwcnmeysvd",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": false,
  3. "result_code": "OK"
  4. }

更新联系方式

sofa.apigateway.contact.update 用于更新一个联系方式。

请求参数

名称 类型 是否必填 示例 描述
param ContactInfoVO - param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN - data

代码示例

请求示例

  1. {
  2. "param": {
  3. "mail": "123@lvk.com",
  4. "contact_id": "iebxpwp3ipl9gmtu",
  5. "name": "zhuowei",
  6. "auth_app_info_id": "oxLIMO8MKn7x6nxy",
  7. "tel": "1533242",
  8. "company": "seu"
  9. },
  10. "tenant_id": "JADDGOCN",
  11. "workspace_id": "antdemo"
  12. }

返回示例

  1. {
  2. "data": true,
  3. "result_code": "OK"
  4. }

通过 ID 查询联系方式

sofa.apigateway.contact.get 用于查询并获取指定联系方式的详细信息。

请求参数

名称 类型 是否必填 示例 描述
contact_id STRING contact_id1 联系方式标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data ContactInfoVO - data

代码示例

请求示例

  1. {
  2. "contact_id": "iebxpwp3ipl9gmtu",
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo"
  5. }

返回示例

  1. {
  2. "data": {
  3. "tenant_id": "JADDGOCN",
  4. "workspace_id": "antdemo",
  5. "mail": "123@lvk.com",
  6. "auth_app_info_id": "oxLIMO8MKn7x6nxy",
  7. "name": "zhuowei",
  8. "tel": "1533242",
  9. "company": "seu",
  10. "contact_id": "iebxpwp3ipl9gmtu"
  11. },
  12. "result_code": "OK"
  13. }

查询联系方式分页列表

sofa.apigateway.contact.list 用于查询联系方式的分页列表。

请求参数

名称 类型 是否必填 示例 描述
param ContactInfoQueryVO - param
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data ContactInfoPagedListVO - data

代码示例

请求示例

  1. {
  2. "param": {
  3. "page_info": {
  4. "page_index": 1,
  5. "page_size": 10
  6. },
  7. "query": {}
  8. },
  9. "tenant_id": "JADDGOCN",
  10. "workspace_id": "antdemo"
  11. }

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 2,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "mail": "123@lvk.com",
  11. "contactId": "iebxpwp3ipl9gmtu",
  12. "name": "zhuowei",
  13. "authAppInfoId": "oxLIMO8MKn7x6nxy",
  14. "tenantId": "JADDGOCN",
  15. "tel": "1533242",
  16. "company": "seu",
  17. "workspaceId": "antdemo"
  18. },
  19. {
  20. "mail": "123@456.com",
  21. "contactId": "G2Vbw8Y8eXORnJYc",
  22. "name": "kk159",
  23. "authAppInfoId": "oxLIMO8MKn7x6nxy",
  24. "tenantId": "JADDGOCN",
  25. "tel": "12345678",
  26. "company": "ant",
  27. "workspaceId": "antdemo"
  28. }
  29. ]
  30. },
  31. "result_code": "OK"
  32. }

通过授权应用 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

代码示例

请求示例

  1. {
  2. "auth_app_info_id":"hg42jDqSYGREHHKN",
  3. "param": {
  4. "page_info": {
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "query": {}
  9. },
  10. "tenant_id": "JADDGOCN",
  11. "workspace_id": "antdemo"
  12. }

返回示例

  1. {
  2. "data": {
  3. "page_info": {
  4. "total": 2,
  5. "page_index": 1,
  6. "page_size": 10
  7. },
  8. "list": [
  9. {
  10. "mail": "zhuoyu.cq@123.com",
  11. "contactId": "rnE8hd4Tg2GGOcYa",
  12. "name": "zhuoyu",
  13. "authAppInfoId": "BzZy3T82r2vr2Jj4",
  14. "tenantId": "JADDGOCN",
  15. "tel": "12345678",
  16. "company": "seu",
  17. "workspaceId": "antdemo"
  18. },
  19. {
  20. "mail": "123@lvk.com",
  21. "contactId": "iebxpwp3ipl9gmtu",
  22. "name": "zhuowei",
  23. "authAppInfoId": "oxLIMO8MKn7x6nxy",
  24. "tenantId": "JADDGOCN",
  25. "tel": "1533242",
  26. "company": "seu",
  27. "workspaceId": "antdemo"
  28. }
  29. ]
  30. },
  31. "result_code": "OK"
  32. }