获取服务窗联系人信息

GET

http://127.0.0.1/v1.0/crm/officialAccounts/contacts/{userId}

新版服务端API（DingTalk OpenAPI）/客户管理

最后修改时间：2022-08-30 09:19:21

责任人：未设置

说明

获取服务窗联系人信息，例如手机号、主企业信息等。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	获取CRM主数据的接口访问权限	API Explorer
第三方企业应用	暂不支持	获取CRM主数据的接口访问权限	暂不支持
第三方个人应用	暂不支持	获取CRM主数据的接口访问权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter	userId cannot be null	用户id非法
400	invalidParameter.invalidOrgId	crm has not been installed for this org	服务窗的组织id非法
403	permission.deny	need user auth	用户未授权
429	system.busy	system busy, request too frequest	请求太频繁，系统限流
503	system.error	system error	系统错误

请求参数

Path 参数

userId

string

必需

服务窗联系人的userid。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://127.0.0.1/v1.0/crm/officialAccounts/contacts/' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

corpName

string

联系人主企业名称。

可选

mobile

string

联系人的手机号。

可选

stateCode

string

手机号国家码。

可选

unionId

string

可选

联系人的unionId，可通过根据userid获取用户详情接口获取。

authItems

array[string]

可选

已经授权的字段，包括手机号，主企业信息等。

userInfos

array[string]

用户实例ID。

可选

示例

{
  "corpName": "string",
  "mobile": "string",
  "stateCode": "string",
  "unionId": "string",
  "authItems": [
    "string"
  ],
  "userInfos": [
    "string"
  ]
}

添加CRM个人客户

获取服务窗联系人信息

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码