私有化客户权益开通及更新

1. 接口描述

接口名称:

/eventopenapi/onpremises/customer/privilege/update

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

Http Headers

参数 类型 必须 说明
Nonce String 是 随机数(随机数,最大长度128个字符)
CurTime String 是 当前UTC时间戳,从1970年1月1日0点0分0秒开始到现在的毫秒数
CheckSum String 是 服务器认证需要,16进制字符小写SHA1(AppSecret+Nonce+CurTime), AppSecret由全时分配, 如果CheckSum值不一致, 不允许请求接口

Http Body

参数 类型 必须 说明
customerInfo Object 是 客户基本信息
salesInfo Object 是 基础销售品信息
attachment JSON 否 增值权益项开通列表
orderId String 是 第三方订单ID
callbackUrl String 是 第三方回调地址
meetingCallbackUrl String 是 会议回调地址

customerInfo 参数说明

参数 类型 必须 说明
customerName String 否 客户名称,(customerCode,appId),customerName 二选一,当customerCode,appId同时为空时, 必须提供客户名称
thirdPartnerId Long 否 第三方客户ID
customerCode String 否 全时客户ID,如果是全时已存在客户,请通过销售获得全时客户ID
appId String 否 全时客户开发者秘钥中的appId

attachment 参数说明

参数 类型 必须 说明
meetingService JSON 否 会议权益
liveService JSON 否 直播会议权益
hardwareVideo JSON 否 硬件视频权益
meetAiSummary JSON 否 智能纪要权益

meetingService

参数 类型 必须 说明
enable Int 否 是否开通会议服务 1:开通 0:关闭
startTime 时间戳 否 权益生效时间,精确到秒
endTime 时间戳 否 权益失效时间,精确到秒

liveService

参数 类型 必须 说明
number Int 否 客户直播并发数
startTime 时间戳 否 权益生效时间,精确到秒
endTime 时间戳 否 权益失效时间,精确到秒

hardwareVideo

参数 类型 必须 说明
number Int 否 硬件视频最大并发数
startTime 时间戳 否 权益生效时间,精确到秒
endTime 时间戳 否 权益失效时间,精确到秒

meetAiSummary

参数 类型 必须 说明
startTime 时间戳 否 权益生效时间,精确到秒
endTime 时间戳 否 权益失效时间,精确到秒

购买标准产品示例

{
    "orderId":"314c6deb-ca7b-43eb-96fb-791523843704",
    "customerInfo":{
        "customerName":"test",
        "thirdPartnerId":"12987",
        "customerCode":"",
        "appId":"iwels-aee231-pwe333"
    },
    "salesInfo":{
        "productType":1,
        "endTime":1765267113,
    },
    "attachment":{
            "meetingService":{
                "enable":1,
                "startTime":1765267113,
                "endTime":1765267113,
            },
            "liveService":{
                "number":232,
                "startTime":1765267113,
                "endTime":1765267113,
            },
            "hardwareVideo":{
                "number":2000,
                "startTime":1765267113,
                "endTime":1765267113,
            },
            "meetAiSummary":{
                "startTime":1765267113,
                "endTime":1765267113,
            }
        }
    "callbackUrl":"http://www.sohu.com",
    "meetingCallbackUrl":"http://www.kdoc.doc.cn/meeting"

}

3. 输出参数

参数 类型 说明
code int 返回的状态码, 200成功
msg String 当返回结果的状态码不为200时,包含的错误信息
data Json -
timeStamp Long 返回时间(时间戳,单位毫秒)
requestId String 请求ID(在接口异常时, 需提供请求ID)

data 参数说明

参数 类型 说明
orderId String 订单ID
orderStatus Int 订单处理结果, 1:订单处理中 2:订单处理成功 3:订单处理失败
  • 接口调用成功,返回状态1
  • 接口调用如果有参数错误,或其他错误, 返回 3
  • 回调中返回2和3两种状态

示例

输出示例

{
    "code": 200,
    "data": {
        "orderId": "10390333",
        "orderStatus": 1
    },
    "msg": "success",
    "requestId": "23-233",
    "timeStamp": 10233333
}

4. 回调

4.1 回调鉴权

Http Headers

参数 类型 必须 说明
Nonce String 是 随机数(随机数,最大长度128个字符)
CurTime String 是 当前UTC时间戳,从1970年1月1日0点0分0秒开始到现在的毫秒数
CheckSum String 是 服务器认证需要,16进制字符小写SHA1(AppSecret+Nonce+CurTime), AppSecret由全时分配, 如果CheckSum值不一致, 不允许请求接口

###4.2 回调更新客户订单状态

参数 类型 说明
code int 返回的状态码, 200成功
msg String 当返回结果的状态码不为200时,包含的错误信息
data Json -
timeStamp Long 返回时间(时间戳,单位毫秒)
requestId String 请求ID(在接口异常时, 需提供请求ID)

data 参数说明

参数 类型 说明
orderId String 订单ID
orderStatus Int 订单处理结果, 1:订单处理中 2:订单处理成功 3:订单处理失败
thirdPartnerId String 金山客户ID
appId String 全时开发者秘钥
appSecret String 全时开发者秘钥
customerCode String 全时客户编码

输出示例

{
"code": 200,
"data": {
    "orderId": "asdasdasdas24234",
    "orderStatus": 2,
    "thirdPartnerId": "09221222",
    "appId": "b70847a3d2b78ff4b4b7ed1ab487fbfd",
    "appSecret": "69be63149dbf6e98cc933dcd8895f273",
    "customerCode": "0012345",
},
"msg": "success",
"requestId": "23-233",
"timeStamp": 10233333
}