添加订单
1. 接口描述
接口名称:
/eventopenapi/gnet/customer/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 | 是 | 销售品信息 |
orderId | String | 是 | 第三方订单ID |
orderType | Int | 是 | 订单类型 1:新购 2:增购 3延期 4:增购+续期 |
callbackUrl | String | 是 | 第三方回调地址 |
meetingCallbackUrl | String | 是 | 会议应用回调地址 |
customerInfo 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
customerName | String | 否 | 客户名称,customerCode,customerName 二选一,当全时不存在该企业时, 必须提供客户名称 |
thirdPartnerId | Long | 是 | 第三方客户ID |
thirdPartnerEncryptId | String | 是 | 第三方客户ID(加密后) |
customerCode | String | 否 | 全时客户ID,如果是全时已存在客户,请通过销售获得全时客户ID |
salesInfo 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
prodId | Int | 否 | 全时产品 1:WPS365全时会议版, 不传默认为1 |
packageType | Int | 是 | 套餐人数规模 1:100人 2:200人 3:300人, 测试时可以为空 |
isTest | Int | 否 | 1:测试 0:非测试, 默认0 |
totalCount | Int | 是 | 开通的总数量 |
telephoneCount | Int | 是 | 电话语音包购买数量,每个语音包1200分钟时长 |
beginTime | 时间戳 | 是 | 订单生效时间,精确到秒 |
buyYears | Int | 是 | 购买时长, 单位年 |
paidMoney | Double | 是 | 实收金额 |
saleName | String | 是 | 销售人员名称 |
saleId | Int | 是 | 销售人员WPSId |
输入示例
{
"orderId": "10390333",
"orderType": 2,
"customerInfo": {
"customerName": "",
"customerCode": "01231",
"thirdPartnerId": 23023,
"thirdPartnerEncryptId": "23023",
},
"salesInfo": {
"prodId": 1,
"package": 1,
"isTest": 0,
"totalCount": 120,
"telponeCount":5,
"mcuCount":3
"beginTime": 1709789004,
"buyYears": 1,
"saleName":"张立",
"salesId": 109333
},
"callbackUrl": "https://wwww.quanshi.com",
"meetingCallbackUrl": "https://wwww.quanshi.com"
}
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"
}