文档首页/ 云客服/ API参考/ OMA接口参考/ 软件云对接接口/ 客户信息查询接口
更新时间：2024-08-02 GMT+08:00
查看PDF
分享

客户信息查询接口

描述

提供给软件云调用，查询OMA侧保存的软件云客户信息。（目前提供给软件云官网试用）

接口方法

GET

接口URI

https://域名/rest/oma/softwareconsole/tenant/querytenantbasic，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-Auth-Token

string

True

软件云侧用户access-token值

响应说明

  • 响应状态码: 200
表2 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

object

True

成功响应码：查询成功

1.1

mobilePhone

String

True

客户手机号码，已做掩码处理

1.2

company

String

True

客户公司名称，已做掩码处理

1.3

customerName

String

True

联系人名称，已做掩码处理

1.4

email

String

True

邮件地址，已做掩码处理

1.5

vdn

String

True

VDN

1.6

createDate

Number

True

创建时间

1.7

tenantSpaceStatus

String

True

租间状态

1.8

portalUrl

String

True

登录AICC的链接地址
  • 响应状态码: 401
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

未授权：1. 请确认是否购买了客户服务云相关服务。 2. 系统管理员登录客户服务云系统，进入“系统参数->统一公共配置->云客户配置”，确认软件云对接官网地址配置是否正确。3.确认请求头参数设置是否正确
  • 响应状态码: 502
表4 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

业务失败

消息样例

  • 场景描述：软件云调用接口查询客户信息 
    URL：/rest/oma/softwareconsole/tenant/querytenantbasic
  • 请求头: 
    {
    "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw="
}
  • 响应头： 
    {
    "connection": "keep-alive", 
    "Content-Length": "16", 
    "Content-Type": "application/json%3Bcharset=UTF-8"
}
  • 响应体： 
    {
    "mobilePhone": "153****0991",
    "company":"华为XXXXXXXXX",
    "customerName":"zXXXXXX",
    "email":"sunk****@huawei.com",
    "vdn":"150",
    "createDate":1681203525000,
    "tenantSpaceStatus":"2",
    "portalUrl":"https://software.huawei.com/auth?client_id=xxxxx&redirect_uri=https://example.com/service-cloud/sm/login/portal.html"
}
父主题： 软件云对接接口