添加订单
1. 接口描述
接口名称:
/eventopenapi/gnet/wps/order/add
发送方式:
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 |
| orderType | Int | 是 | 订单类型 1:基础产品新购 2基础产品延期 3:基础产品取消 |
| callbackUrl | String | 是 | 第三方回调地址 |
| meetingCallbackUrl | String | 是 | 会议回调地址 |
customerInfo 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| customerName | String | 否 | 客户名称,customerCode,customerName 二选一,当全时不存在该企业时, 必须提供客户名称 |
| thirdPartnerId | Long | 是 | 第三方客户ID |
| customerCode | String | 否 | 全时客户ID,如果是全时已存在客户,请通过销售获得全时客户ID |
salesInfo 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| productType | Int | 是 | 基础产品类型, 1:标准全时云会议 2:公共会议室 |
| beginTime | 时间戳 | 是 | 订单生效时间,精确到秒 |
| endTime | 时间戳 | 是 | 订单截止时间,精确到秒 |
| publicMeetingRooms | JSON | 否 | 公共会议室属性 |
publicMeetingRooms 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| hostNumbers | Int | 否 | 主持人账号个数 |
| rooms | JSONArray | 否 | 公共会议室购买信息 |
rooms 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| limit | Int | 否 | 会议最大方数, 目前仅支持: 50, 100, 300, 500, 1000, 2000五个值 |
| number | Int | 否 | 购买的会议室个数 |
attachment 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| templateConference | JSON | 否 | 模版会议相关权益 |
| liveService | JSON | 否 | 直播会议权益 |
| aiSpeakWorld | JSON | 否 | 同声传译权益 |
| overseasSpeedUp | JSON | 否 | 海外加速权益 |
| rooms | JSON | 否 | rooms权益 |
| chinaTelephone | JSON | 否 | 国内电话权益 |
templateConference
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
liveService
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| packageNumber | Int | 否 | 流量包个数, 一个流量包xTB, 如果enbale = 1, 此参数必传 |
chinaTelephone
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| packageNumber | Int | 否 | 电话流量包个数, 一个流量包x分钟, 如果enbale = 1, 此参数必传 |
InternationalTelephone
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| packageNumber | Int | 否 | 电话流量包个数, 一个流量包x分钟, 如果enbale = 1, 此参数必传 |
aiSpeakWorld
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| totalHours | Int | 否 | 同声传译小时数, 如果enbale = 1, 此参数必传 |
mtgHub
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| totalMinutes | Int | 否 | mtgHub入会总分钟数, 如果enbale = 1, 此参数必传 |
overseasSpeedUp
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| totalHours | Int | 否 | overseasSpeedUp使用总小时数, 如果enbale = 1, 此参数必传 |
rooms
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| number | Int | 否 | rooms个数, 如果enbale = 1, 此参数必传 |
hardwareVideo
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| portNumber | Int | 否 | 硬件视频最大并发数, 如果enbale = 1, 此参数必传 |
hardwareVideo
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| enable | Int | 否 | 0:不开通 1:开通 |
| portNumber | Int | 否 | 硬件视频最大并发数, 如果enbale = 1, 此参数必传 |
购买标准产品示例
{
"orderId":"314c6deb-ca7b-43eb-96fb-791523843704",
"productType" : 1,
"orderType":1
"customerInfo":{
"customerName":"test",
"thirdPartnerId":"12987",
"customerCode":""
},
"salesInfo":{
"productType":1,
"beginTime":1765267113,
"endTime":1765267113,
},
"attachment":{
"templateConference":{
"enable": 1
},
"liveService":{
"enable": 1,
"packageNumber":2
},
"aiSpeakWorld":{
"enable": 1,
"totalHours":200
},
"rooms":{
"enable": 1,
"number":5
},
"chinaTelephone":{
"enable": 0,
"packageNumber":2000
},
"hardwareVideo":{
"enable": 0,
"portNumber":2000
},
"mtgHub":{
"enable": 0,
"totalMinutes":2000
},
"overseasSpeedUp":{
"enable": 0,
"totalHours":2000
}
}
"callbackUrl":"http://www.sohu.com",
"meetingCallbackUrl":"http://www.kdoc.doc.cn/meeting"
}
购买公共会议室产品示例
{
"orderId":"314c6deb-ca7b-43eb-96fb-791523843704",
"productType" : 1,
"orderType":1
"customerInfo":{
"customerName":"test",
"thirdPartnerId":"12987",
"customerCode":""
},
"salesInfo":{
"productType":1,
"beginTime":1765267113,
"endTime":1765267113,
"publicMeetingRooms":[
{
"limit" : 100,
"number": 3
},
{
"limit" : 300,
"number": 1
}
]
},
"attachment":{
"templateConference":{
"enable": 1
},
"liveService":{
"enable": 1,
"packageNumber":2
},
"aiSpeakWorld":{
"enable": 1,
"totalHours":200
},
"rooms":{
"enable": 1,
"number":5
},
"chinaTelephone":{
"enable": 0,
"packageNumber":2000
},
"hardwareVideo":{
"enable": 0,
"portNumber":2000
},
"mtgHub":{
"enable": 0,
"totalMinutes":2000
},
"overseasSpeedUp":{
"enable": 0,
"totalHours":2000
}
}
"callbackUrl":"http://www.sohu.com",
"meetingCallbackUrl":"http://www.kdoc.doc.cn/meeting"
}
## 3. 输出参数
| 参数 | 类型 | 说明 |
| --------- | ------ | -------------------------------------- |
| timeStamp | Long | 返回时间(时间戳,单位毫秒)|
| requestId | String | 请求ID(在接口异常时, 需提供请求ID)|
| code | Int | 返回的状态码 |
| msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
| data | Json | - |
data 参数说明
| 参数 | 类型 | 说明 |
| --------- | ------ | -------------------------------------- |
| orderId | String | 订单ID|
| orderType | String | 订单类型|
| status | Int | 订单处理结果, 1:订单处理中 2:订单处理成功 3:订单处理失败 |
* 接口调用成功,返回状态1
* 接口调用如果有参数错误,或其他错误, 返回 3
* 回调中返回2和3两种状态
示例
输出示例
{ "orderId": "10390333", "orderType": 2, "status":1
}
## 4. 回调
全时执行完业务逻辑后, 通过回调接口, 通知金山结果
| 参数 | 类型 | 说明 |
| --------- | ------ | -------------------------------------- |
| orderId | String | 订单ID|
| orderStatus | boolean | 订单处理结果, true:成功, false:失败 |
| appId | String | 全时开发者秘钥|
| appSecret | String | 全时开发者秘钥|
| customerCode | String | 全时客户编码|
| failedReason | String | 消息|
| companyId | Long | 金山客户ID|
输出示例
{ "companyId": 683098735, "orderId": "asdasdasdas24234", "appId": "b70847a3d2b78ff4b4b7ed1ab487fbfd", "orderStatus": true, "customerCode": "0012345", "appSecret": "69be63149dbf6e98cc933dcd8895f273" }
```


