版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

限制说明:允许一秒请求一次,否则返回:操作频繁,请稍后重试

应用权限:   用户->用户资料

接口地址 访问路径 :   /api/audience/detail

Type: POST

...

ParameterTypeRequiredDescription

companyId

string

false

第三方平台企业id

audienceUserIdList

array

false

用户档案ID集合

thirdIdList

array

false

第三方客户ID集合

phoneList

array

false

手机号集合

instanceAppid

string

false

应用实例ID

传参注意:

1.audienceUserIdList,thirdIdList,phoneList这3个集合参数不能同时为空。

2.如果companyId不传,会通过token校验拿到当前数据集成对应的企业信息,去查询用户信息返回。

3.如果要查询数据集成应用下面子企业的客户信息,那么companyId一定要传。


Response-fields:

FieldTypeDescriptionSince

code

string

状态码

-

errorCode

string

错误状态码

-

msg

string

状态描述

-

data

array

数据

-

└─orgId

string

兔展企业Id

-

└─createTime

string

创建时间,时间戳

-

└─audienceUserId

int64

客户ID

-

└─openids

array

openid列表

"openids": [
{
"openid": "openid",
"appId":"公众平台appid"

......
}
]

-

     └─openid

string

如果是企业微信,那么存的是客户联系external_userid、 userid

-

     └─unionid

string

微信的unionid、如果是企业微信,那么存的是客户联系unionid

-

     └─fromTo

string

contentminiapp 小程序,workwechat 企业微信外部联系人,gzh 公众号、workwechatgroup 客户群

-

     └─appid

string

如果是小程序则小程序id,公众号则公众号ID,企业微信则企业微信ID 企业微信成员 workwechat_employee

-

     └─platform

string

平台:gzh,workwechat (第三方的外部联系人)、selfbuilt(自建应用外部联系人)、YOUZAN、EZR、RP_LSY (兔展零售云)

-

     └─jcappid

int64

系统集成的应用ID

-

     └─identityId

string

系统集成身份ID

-

     └─identityType

string

系统集成的身份类型" //如 phone 手机、uid 用户ID,openid 微信openid

-

└─unionid

string

微信unionid

-

└─mpAppid

string

公众号appid

-

└─phoneList

array

手机号码列表

"phoneList": [
{
"phone": "18819270183", 
"isVerify":"1" 0未验证 1 验证
}
]

-

     └─phone

string

手机号

-

     └─isVerify

string

0未验证 1 验证

-

└─realName

string

真实姓名

-

└─sex

int32

性别(1 男 2 女 0 未知)

-

└─avatar

string

头像

-

└─wxNickname

string

微信昵称

-

└─wxCountry

string

微信资料获取的国家名称

-

└─wxProvince

string

微信资料获取的省名称

-

└─wxCity

string

微信资料获取的市名称

-

└─province

string

最近通过IP获取的省名称

-

└─city

string

最近通过IP获取的市名称

-

└─lbsProvince

string

通过地理位置授权获取的省名称

-

└─lbsCity

string

通过地理位置授权获取的市名称

-

└─addressList

array

地址列表

-

     └─any object

object


-

└─birthday

int64

生日 ,时间戳

-

└─remark

string

备注

-

└─lastActiveTime

int64

最近活跃时间 ,时间戳

-

└─gzhInteractTime

int64

公众号最后互动时间 ,时间戳

-

└─markFlag

int32

是否星标  1 是  0 否

-

└─userType

array

用户类型列表

["个人","商家"]

-

     └─any object

object

any object.

-

└─payFeature

string

付款特点

-

└─industry

array

行业

["科技服务/互联网"]

-

     └─any object

object

any object.

-

└─subWechatList

array

客户关注的公众号列表

[{"appid":"123456","wechatName":"兔展"}]

-

     └─any object

object

any object.

-

└─sourceAudid

int64

创建客户档案时的上一层级传播客户Id

-

└─sourceCnl

int64

创建客户档案时的来源渠道

-

└─sourceCnlName

string

创建客户档案时来源渠道的名称(员工=姓名,自有渠道=名称,如果后续还有门店渠道则显示门店名称)

-

└─sourceCnlDeptId

int64

创建客户档案时的来源渠道部门Id

-

└─sourceCnlDeptName

string

创建客户档案时的来源渠道部门的名称

-

└─sourceCnlType

string

创建客户档案时的来源渠道类型

EMPLOYEE  员工   FIXED 自有渠道

-

└─sourceAppType

string

创建客户档案时的来源作品类型:

微信
微博
QQ空间
QQ
今日头条
知客名片
编辑器小程序
内容小程序
公众号
企业微信
其他

-

└─active

int64

总活跃度

-

└─weekActive

object

7天活跃度

{"count":数量,"updateTime":时间戳}

-

└─monthActive

object

30天活跃度

{"count":数量,"updateTime":时间戳}

-

└─spread

int64

传播力

-

└─weekSpread

object

7天传播力

{"count":数量,"updateTime":时间戳}

-

└─monthSpread

object

30天传播力

{"count":数量,"updateTime":时间戳}

-

└─phone

string

手机号码

-

└─wechatList

array

授权公众号列表,取关不会删除

-

     └─appid

string

公众号appid

-

     └─wechatName

string

公众号名称

-

     └─gzhInteractTime

int64

公众号互动时间

-

     └─firstSubDate

int64

第一次关注时间

-

     └─firstSubSourceCnlType

string

第一次关注的来源渠道类型

-

     └─firstSubSourceCnl

int64

第一次关注的来源渠道id

-

     └─firstSubSourceCnlDeptId

int64

第一次关注的来源渠道部门id

-

     └─firstSubSourceTaskId

int64

第一次关注的来源任务id

-

└─thirdId

string

第三方用户ID

-


RequestCurl-body-example:

...

代码块
curl -X POST -k -H 'Content-Type: application/json; charset=utf-8'  --header 'X-Token: Wdr95VZ9nMorbE_RKqQ-GvaEiAc' -i https://devintegrate.rabbitpre.com/api/open/api/audience/detail --data '{ "companyId": "31",

...

 

...

"audienceUserIdList": [

...

 747

...

 

...

],

...

 

...

"thirdIdList": [

...

 

...

"0rtxiw"

...

 ],

...

 

...

"phoneList": [

...

 

...

"ncqtyf"

...

 ],

...

 

...

"instanceAppid": "31" }'

...




Response-example:

代码块
{
    "code":

...

"

...

200",
    "errorCode":

...

"

...

SUCCESS",
    "msg":

...

"

...

ok",
    "data":

...

[
        {
            "orgId":

...

"928a852d-e749-45be-bc31-f8e23f07b999",
            "createTime":

...

1559096182000,
            "audienceUserId":

...

123,
            "openids":

...

[
                {
                    "openid":

...

"

...

oqm2m5MEyDHmLy3ySThLOHsiM22",
         

...

 

...

          "

...

appId":

...

"

...

123456"

...


              

...

  }
          

...

  ],
            "

...

unionid":

...

"oilcW5hX5zbPudKpeAKVAGz9u11",
            "

...

mpAppid":

...

"

...

wx59e26bd946c5e7d7",
            "

...

phoneList":

...

[
          

...

      

...

{
      

...

 

...

      

...

 

...

      "

...

phone":

...

"13888888888",
          

...

          "

...

isVerify":

...

"

...

1"

...


            

...

    }
      

...

      ],
            "realName":

...

"

...

小兔子",
            "sex":

...

1,
            "avatar":

...

"https://file3.rabbitpre.com/f5c8c727-cc57-4f6d-8874-1895cfc875ee-7266",
            "wxNickname":

...

"

...

小兔子",
            "wxCountry":

...

"

...

中国",
            "wxProvince":

...

"

...

广东",
            "wxCity":

...

"

...

深圳",
            "province":

...

"

...

广东",
            "city":

...

"

...

深圳",
            "lbsProvince":

...

"

...

广东",
            "lbsCity":

...

"

...

深圳",
            "addressList":

...

[
                {

...


      

...

       

...

 

...

      "

...

address":

...

"

...

深圳兔展智能科技有限公司"

...


       

...

        

...

 

...

},
      

...

         

...

 

...

{
        

...

      

...

      "

...

address":

...

"

...

深圳市南山区深圳湾科技生态园9栋B-4座429-432号"

...


      

...

          

...

}
            ],
            "

...

birthday":

...

1567180800000,
            

...

"remark":"重要客户",
      

...

      "

...

lastActiveTime":

...

1566972932910,
      

...

      "gzhInteractTime":

...

1566972932910,
            "

...

markFlag":

...

1,
            "

...

userType":

...

[
               

...

 "

...

个人",
                "

...

商家"
            ],
            "

...

payFeature":

...

"

...

购买模版",
            "

...

industry":

...

[
                "商品交易/家居",
      

...

          "

...

商品交易/电子数码"

...


 

...

 

...

 

...

 

...

 

...

 

...

      

...

],
      

...

      "subWechatList":[
  

...

        

...

 

...

 

...

 

...

 

...

 

...

 {
           

...

         "

...

appid":

...

"wx35f5cc5cd3869597",
        

...

            "

...

wechatName":

...

"精准云销"
                }

...


      

...

      ],
            "

...

sourceAudid":

...

"578258176454037504",
            "sourceCnl":"587694118680006656",
      

...

      "

...

sourceCnlName":

...

"

...

张三",
            "

...

sourceCnlDeptId":

...

"614470299227918336",
            

...

"sourceCnlDeptName":"财务",
            "

...

sourceCnlType":

...

"

...

EMPLOYEE",
            "

...

sourceAppType":

...

"

...

微信",
            "

...

active":

...

14,
            "

...

spread":

...

10,
            "

...

weekActive":{
          

...

      "count":4,
                "

...

updateTime":1566942300216
 

...

          

...

 

...

},
            "

...

monthActive":{
 

...

         

...

      

...

"count":10,
                "

...

updateTime":

...

1566942300216
          

...

  

...

Curl-example:

代码块
curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -i https://devintegrate.rabbitpre.com/api/open/api/audience/detail --data '{ "companyId": "31", "audienceUserIdList": [ 747 ], "thirdIdList": [ "0rtxiw" ], "phoneList": [ "ncqtyf" ], "instanceAppid": "31" }'

},
            "weekSpread":{
                "count":10,
                "updateTime":1566942300216
            },
            "monthSpread":{
                "count":10,
                "updateTime":1566942300216
            }
        }
    ]
}