获取服务端链接
1. 接口描述
接口名称:
/eventopenapi/mcenter/thirdconf/getServerUrl
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
returnWebsiteUrl | Boolean | 否 | 是否返回站点链接,默认false |
timeout | Int | 否 | authCode可用时间,默认5分钟 |
usableCount | Int | 否 | authCode可用次数,默认6次 |
name | String | 是 | 姓名,当returnWebsiteUrl=true时 必填 |
openId | String | 否 | 企业微信唯一id |
icon | String | 否 | 用户头像 |
countryCode | String | 否 | 国家码 |
mobile | String | 否 | 手机号 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
customerCode | String | 客户编码 |
websiteBasicUrl | String | 专属站点链接,当returnWebsiteUrl=true,返回 |
mineUrl | String | 专属站点我的链接,当returnWebsiteUrl=true,返回 |
adminHost | String | 管理中心地址 |
meetHost | String | meet地址 |
eventHost | String | event地址 |
umsauthHost | String | 统一登录地址 |
siteHost | String | 站点地址 |
fsServerHost | String | fsServer地址 |
liveHost | String | 直播地址 |
4. 示例
输入示例1: 获取服务端其他链接
{
"returnWebsiteUrl":false
}
输出示例
{
"timeStamp": 1660724273785,
"code": 200,
"msg": "Successfully to getServerUrl!",
"data": {
"customerCode": "153857",
"fsServerHost": "https://testbeefs.quanshi.com/ucfserver",
"siteHost": "https://live-test.qsh1.cn",
"umsauthHost": "https://test-umsauth.quanshi.com",
"meetHost": "https://meetservicem.quanshi.com",
"eventHost": "https://event-dev.quanshi.com",
"liveHost": "https://ltest.qsh1.cn",
"adminHost": "http://testweb.quanshi.com"
},
"requestId": "192.168.12.12_20220817_161752_1660724272377"
}
输入示例2: 获取服务端链接
{
"returnWebsiteUrl":true,
"timeout":30,
"usableCount":100,
"icon":"dfsf",
"mobile": "180192839191",
"countryCode": "86",
"openId": "1224124",
"name": "test"
}
输出示例
{
"timeStamp": 1660724988988,
"code": 200,
"msg": "Successfully to getMineUrl!",
"data": {
"customerCode": "153857",
"fsServerHost": "https://testbeefs.quanshi.com/ucfserver",
"siteHost": "https://live-test.qsh1.cn",
"umsauthHost": "https://test-umsauth.quanshi.com",
"websiteBasicUrl": "https://live-test.qsh1.cn/website/153857",
"meetHost": "https://meetservicem.quanshi.com",
"eventHost": "https://event-dev.quanshi.com",
"mineUrl": "https://event-dev.quanshi.com/website/153857#/mine/index?authCode=34d7f476-5b58-45c7-990d-db1cfae7effd",
"liveHost": "https://ltest.qsh1.cn",
"adminHost": "http://testweb.quanshi.com"
},
"requestId": "192.168.12.12_20220817_162947_1660724987092"
}