API文档

会员接口

接口列表

接口名称 接口方法 说明
1.修改会员信息 Member.UpdateMember 在办理会员时没有填写完整的会员信息或者漏填的情况下可根据此接口修改会员信息
2.登陆并绑定微信 Member.LoginAndBinding 登陆并绑定微信
3.查询会员积分明细 Member.SearchPoints 查询会员一段时间内的所有积分，包括消费的和获取的
4.查询会员储值明细 Member.SearchValues 查询会员一段时间内的所有储值，包括消费的和获取的
5.注册会员 Member.RegisterMember 注册会员，个人用户通过网络渠道自行注册会员，可以使用此方法，如果有填写OpenId，注册成功后会将此会员与OpenId绑定
6.通过旧密码修改密码 Member.ChangePasswordByOldPassword 通过旧密码修改密码
7.通过手机号修改密码 Member.ChangePasswordByMobile 通过手机号修改密码
8.微信查询会员 Member.GetMemberByOpenId 微信查询会员
9.搜索会员 Member.SearchMembers 搜索会员
10.添加积分 Member.AcquirePoint 添加积分
11.消费积分 Member.ConsumePoint 消费积分
12.添加储值 Member.AcquireValue 添加储值
13.消费储值 Member.ConsumeValue 消费储值
14.停用单店会员储值手机验证码 Member.DisableSingleHotelMemberMobileCode 停用单店会员储值手机验证码
15.升级会员等级 Member.UpgradeMemberLevel 升级会员等级，支持免费与现金方式
16.获取自动升级到下一等级所需的积分、储值和间夜 Member.GetNextLevelCondition 该方法仅适用于自动升级设定为单条款的酒店，不支持单店储值的场景
17.获取自动升级条件 Member.GetAutoUpgradeCondition 获取所有有效的会员自动升级条件
18.积分兑换礼品 Member.ExchangeGift 使用会员积分兑换礼品

1.修改会员信息

Member.UpdateMember

应用场景

在办理会员时没有填写完整的会员信息或者漏填的情况下可根据此接口修改会员信息。

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
姓名 Name 否 string
手机号 Mobile 否 string
证件类型 IdType 否 string 身份证，居民户口簿 详细见数据字典“证件类型”
证件号 IdNo 否 string
电子邮件地址 Email 否 string
性别 Gender 否 string "0" 未知 "1" 女 "2" 男
地址 Address 否 string
外卡号 ExtCardNo 否 string 修改外卡号时传入
酒店编号 OrgId 否 string 修改外卡号时传入

示例

{
     "ChannelKey":"web",
     "Method":"Member.UpdateMember",
     "BizContent":"{\"MemberId\":\"101520724\",\"Name\":\"眨热泅髓\",
     \"Mobile\":\"13041819237\",\"IdType\":\"C02\",\"IdNo\":\"6266246485843215\",
     \"Email\":\"esnvizzcjk@163.com\",\"Gender\":\"1\",
     \"Address\":\"崩宏驼咱脓而揣护揭犁彦历暗皿缅蒂胯滔狠峨欧眺\"}",
     "Sign":"2622F38724ABB4E3404E57A1B3C53461",
     "SignType":"MD5",
     "Format":"json",
     "Charset":"utf-8",
     "Version":"1.0",
     "Timestamp":"2017-02-12 14:12:13"
}

其中BizContent是接口参数的json字符串，其json格式如下：

{
    "MemberId":"101520724",
    "Name":"眨热泅髓",
    "Mobile":"13041819237",
    "IdType":"C02",
    "IdNo":"6266246485843215",
    "Email":"esnvizzcjk@163.com",
    "Gender":"1",
    "Address":"崩宏驼咱脓而揣护揭犁彦历暗皿缅蒂胯滔狠峨欧眺"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
Void 接口返回值为：void

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":null
}

业务异常码表

Code
（返回码） 		Message
（返回码描述） 		SubCode
（业务返回码） 		SubMessage
（业务返回码描述） 		解决方案
50000 业务处理失败 crm.unknow-error 未知错误
crm.gift-exchange-failed 礼品兑换失败
crm.invalid-member-id 无效的MemberId
crm.member-already-exist 会员已存在
crm.member-not-found 找不到对应的会员
crm.missing-gift-exchange-info 缺少兑换的商品信息
crm.operation-failed 操作失败

2.登陆并绑定微信

Member.LoginAndBinding

应用场景

登陆并绑定微信

请求参数

字段名 变量名 必填 类型 示例值 描述
手机号 Mobile 是 string
登陆密码 Password 是 string
微信OpenId OpenId 是 string

示例

{
    "ChannelKey":"web",
    "Method":"Member.LoginAndBinding",
    "BizContent":"{\"Mobile\":\"13094071546\",\"Password\":\"p@ssw0rd\",
    \"OpenId\":\"4984834215184769991603861939\"}",
    "Sign":"BBACAB28C60E99BFB0C2C4D2607E6593",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
bool 成功或失败

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":true
}

3.查询会员积分明细

Member.SearchPoints

应用场景

查询会员一段时间内的所有积分，包括消费的和获取的

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
开始日期 StartDate 是 DateTime
结束日期 EndDate 是 DateTime
页码 PageIndex 是 int 从1开始
每页数量 PageSize 是 int

示例

{
    "ChannelKey":"web",
    "Method":"Member.SearchPoints",
    "BizContent":"{\"PageIndex\":1,\"PageSize\":1000,\"MemberId\":\"101517429\",
    \"StartDate\":\"2017-12-21\",\"EndDate\":\"2017-12-22\"}",
    "Sign":"52436A834E2AF3C285E06A88CFD1E26D",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
积分获取或消费的时间 PointTime 是 DateTime
过期时间 PastTime 是 DateTime
积分类型 IsConsume 是 bool true代表消费积分，false代表获取积分
积分 Point 是 decimal
备注 Remark 是 string
创建人 CreateBy 是 string
关联门店 OrgId 是 string
关联入住单 CheckinId 是 string
积分获取或消费的方式 PointWay 是 string
积分渠道 PointChannel 是 string
积分状态 Status 是 string

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":{
        "TotalPage":1,
        "TotalRecord":14,
        "Data":[{
            "MemberId":"101517429",
            "PointTime":"2017-12-21T09:58:45.333",
            "PastTime":"0001-01-01T00:00:00",
            "IsConsume":true,
            "Point":57.0,
            "Remark":"老额抨寂舜授演蝴疼撒",
            "CreateBy":"superadmin",
            "OrgId":"660247752032257",
            "CheckinId":null,
            "PointWay":"兑换酒店免房",
            "PointChannel":"门店",
            "Status":"全部消费"
        },
        {
            "MemberId":"101517429",
            "PointTime":"2017-12-21T09:58:46.777",
            "PastTime":"0001-01-01T00:00:00",
            "IsConsume":true,
            "Point":61.0,
            "Remark":"堵拦察俊旭屠斧俩秩川卧稻",
            "CreateBy":"superadmin",
            "OrgId":"660247752032257",
            "CheckinId":null,
            "PointWay":"兑换早餐",
            "PointChannel":"门店",
            "Status":"全部消费"
        }],
        "PageIndex":1,
        "PageSize":1000
}}

4.查询会员储值明细

Member.SearchValues

应用场景

查询会员一段时间内的所有储值，包括消费的和获取的

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
开始日期 StartDate 是 DateTime
结束日期 EndDate 是 DateTime
页码 PageIndex 是 int 从1开始
每页数量 PageSize 是 int

示例

{
    "ChannelKey":"web",
    "Method":"Member.SearchValues",
    "BizContent":"{\"PageIndex\":1,\"PageSize\":1000,\"MemberId\":\"101517429\",
    \"StartDate\":\"2017-12-21\",\"EndDate\":\"2017-12-22\"}",
    "Sign":"2FAB2E3F8658A772D3E141E78EB397EC",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
储值获取或消费的时间 ValueTime 是 DateTime
储值类型 IsConsume 是 bool true代表消费储值，false代表获取储值
储值金额 Amount 是 decimal
是否是赠送的储值 IsGive 是 bool
储值获取或消费的方式 MoneyWay 是 string
储值渠道 MoneyChannel 是 string
储值获取或消费的酒店Id OrgId 是 string
关联入住单 CheckinId 是 string
储值获取或消费的酒店名称 OrgName 是 string
备注 Remark 是 string
单店储值酒店Id SingleValueOrgId 是 string 如果此字段有值，代表这笔储值仅能在这家门店使用

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":{
        "TotalPage":1,
        "TotalRecord":4,
        "Data":[{
            "MemberId":"101517429",
            "ValueTime":"2017-12-21T09:58:44.82",
            "IsConsume":false,
            "Amount":54.0,
            "IsGive":false,
            "MoneyWay":"",
            "MoneyChannel":"门店",
            "OrgId":"660247752032257",
            "OrgName":null,
            "Remark":"AcquireValueCase",
            "CheckinId":"0",
            "SingleValueOrgId":null
        },
        {
            "MemberId":"101517429",
            "ValueTime":"2017-12-21T00:00:00",
            "IsConsume":false,
            "Amount":10.57,
            "IsGive":false,
            "MoneyWay":"购买",
            "MoneyChannel":"网络",
            "OrgId":"660247752032257",
            "OrgName":null,
            "Remark":null,
            "CheckinId":"0",
            "SingleValueOrgId":null
        }],
        "PageIndex":1,
        "PageSize":1000
}}

5.注册会员

Member.RegisterMember

应用场景

注册会员，个人用户通过网络渠道自行注册会员，可以使用此方法，如果有填写OpenId，注册成功后会将此会员与OpenId绑定

请求参数

字段名 变量名 必填 类型 示例值 描述
姓名 Name 是 string
手机号 Mobile 是 string
证件类型 IdType 否 string 通过网络渠道注册时可不填，必须使用别样红数据字典中指定编码
证件号 IdNo 否 string 通过网络渠道注册时可不填
会员级别 MemberLevel 否 string
销售员Id SalesId 否 string 某些需要统计销售员的场景（如扫码注册），可以填写此字段，此字段必须为Pms中的销售员
密码 Password 否 string
密码提示问题 Question 否 string 当包含密码时，必填
密码提示问题的答案 Answer 否 string 当包含密码时，必填
微信的OpenId OpenId 否 string 当OpenId不为null或空时，注册成功后会将会员与此OpenId绑定
微信的PublicNo PublicNo 否 string

示例

{
    "ChannelKey":"web",
    "Method":"Member.RegisterMember",
    "BizContent":"{\"Name\":\"狂蹬拟毁\",\"Mobile\":\"13086142022\",
    \"IdType\":\"C01\",\"IdNo\":\"806544906017346901\",\"MemberLevel\":\"A\",
    \"Password\":\"p@ssw0rd\"}",
    "Sign":"5D754E87141BA74ECB753CC3551F2578",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 string 注册成功时返回会员Id，失败返回空字符串

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":"101520722"
}

6.通过旧密码修改密码

Member.ChangePasswordByOldPassword

应用场景

通过旧密码修改密码

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
旧密码 OldPassword 是 string
新密码 NewPassword 是 string

示例

{
    "ChannelKey":"web",
    "Method":"Member.ChangePasswordByOldPassword",
    "BizContent":"{\"MemberId\":\"101520723\",\"OldPassword\":\"p@ssw0rd\",
    \"NewPassword\":\"!@#$%^\\u0026*()_+\"}",
    "Sign":"08873A830CB3C56A4E378651FDA09235",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool 成功或失败

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":true
}

7.通过手机号修改密码

Member.ChangePasswordByMobile

应用场景

通过手机号修改密码

请求参数

字段名 变量名 必填 类型 示例值 描述
手机号 Mobile 是 string
新密码 NewPassword 是 string

示例

{
    "ChannelKey":"web",
    "Method":"Member.ChangePasswordByMobile",
    "BizContent":"{\"Mobile\":\"13012667482\",\"NewPassword\":\"p@ssw0rd\"}",
    "Sign":"48A5E3778FDF10E634C032F358502012",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
是 bool 成功或失败

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":true
}

8.微信查询会员

Member.GetMemberByOpenId

应用场景

微信查询会员

请求参数

字段名 变量名 必填 类型 示例值 描述
微信openId openId 是 string

示例

{
    "ChannelKey":"web",
    "Method":"Member.GetMemberByOpenId",
    "BizContent": "{\"OpenId\":\"9861793904875828688048581731\"}",
    "Sign":"CC07602C065966BF970719E025862AFE",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
会员编号 MemberId 是 string
姓名 Name 是 string
性别 Gender 是 string
手机 Mobile 是 string
邮箱 Email 是 string
证件类型 IDType 是 string
证件号 IDNO 是 string
在用卡号 MemberCardId 是 string
会员状态 StatusCode 是 string
会员级别 MemberLevel 是 string
会员级别名称 MemberLevelName 是 string
储值余额 Value 是 decimal
积分余额 Point 是 decimal
生日 BirthDay 是 DateTime
来源门店 SourceDetailCode 是 string
外卡号 ExtCardNo 是 string
会员备注 Remark 是 string
ParentCardNo 是 string
国籍 NationCode 是 string
传真 Fax 是 string
电话 Phone 是 string
信用值 CreditScore 是 decimal
是否永久会员 IsPermanentLevel 是 bool
是否存在密码 ExistPassword 是 bool
是否酒店新客 IsHotelNewUser 是 bool 美团Deep专用

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":{
        "MemberId":"101520723",
        "Name":"隋砰摆告",
        "Gender":"1",
        "Mobile":"13015710136",
        "Email":"vmlzmpyows@163.com",
        "IDType":"C02",
        "IDNO":"6412358674051754",
        "MemberCardId":null,
        "StatusCode":"I",
        "MemberLevel":"A",
        "MemberLevelName":null,
        "Value":0.0000,
        "Point":0.0000,
        "BirthDay":null,
        "SourceDetailCode":null,
        "ExtCardNo":null,
        "Remark":null,
        "ParentCardNo":null,
        "NationCode":null,
        "Fax":null,
        "Phone":null,
        "CreditScore":0.0,
        "IsPermanentLevel":false,
        "ExistPassword":false,
        "IsHotelNewUser":null
}}

9.搜索会员

Member.SearchMembers

应用场景

组合查询会员

请求参数

字段名 变量名 必填 类型 示例值 描述
姓名 Name 7选一必填 string
邮箱 Email string
手机 Mobile string
卡号 CardNo string
外卡号 ExtCardNo string
身份证号 IdNo string
会员Id MemberIds string[] 可以查询多个会员（不超过20个）
会员级别 Levels 否 string[]
状态码 StatusCode 否 string
页码 PageIndex 是 int
每页数量 PageSize 是 int

示例

{
    "ChannelKey":"web",
    "Method":"Member.SearchMembers",
    "BizContent":"{\"IdNo\":\"757404760625501340\",\"PageIndex\":1,\"PageSize\":1000}",
    "Sign":"27002ACED21BD90A8805E9E8FD252F37",
    "SignType":"MD5",
    "Format":"json",
    "Charset":"utf-8",
    "Version":"1.0",
    "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
会员编号 MemberId 是 string
姓名 Name 是 string
性别 Gender 是 string
手机 Mobile 是 string
邮箱 Email 是 string
证件类型 IDType 是 string
证件号 IDNO 是 string
在用卡号 MemberCardId 是 string
会员状态 StatusCode 是 string
会员级别 MemberLevel 是 string
会员级别名称 MemberLevelName 是 string
储值余额 Value 是 decimal
积分余额 Point 是 decimal
生日 BirthDay 是 DateTime
来源门店 SourceDetailCode 是 string
外卡号 ExtCardNo 是 string
会员备注 Remark 是 string
ParentCardNo 是 string
国籍 NationCode 是 string
传真 Fax 是 string
电话 Phone 是 string
信用值 CreditScore 是 decimal
是否永久会员 IsPermanentLevel 是 bool
是否存在密码 ExistPassword 是 bool
是否酒店新客 IsHotelNewUser 是 bool 美团Deep专用

示例

{
    "Code":10000,
    "Message":null,
    "SubCode":null,
    "SubMessage":null,
    "Data":{
        "PageSize":1000,
        "PageIndex":1,
        "RecordCount":1,
        "PageCount":1,
        "Content":[{
            "MemberId":"101520723",
            "Name":"禽春鸭气",
            "Gender":"0",
            "Mobile":"13012667482",
            "Email":null,
            "IDType":"C01",
            "IDNO":"757404760625501340",
            "MemberCardId":"002OEHY2B8002",
            "StatusCode":"I",
            "MemberLevel":"A",
            "MemberLevelName":null,
            "Value":0.0000,
            "Point":0.0000,
            "BirthDay":null,
            "SourceDetailCode":null,
            "ExtCardNo":null,
            "Remark":null,
            "ParentCardNo":null,
            "NationCode":null,
            "Fax":null,
            "Phone":null,
            "CreditScore":0.0,
            "IsPermanentLevel":false,
            "ExistPassword":false,
            "IsHotelNewUser":null
        }]
}}

10.添加积分

Member.AcquirePoint

应用场景

添加积分

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
酒店ID OrgId 是 string
积分获取方式 PointWay 是 string 房费：0
手工调整积分：11
积分转入：3
活动赠送：4
积分 Point 是 decimal
备注 Remark 是 string
积分产生渠道 PointChannel 是 string 门店：A
网络（网站、微信、手机APP等）：C
其它：Z
操作时间 CreateTime 否 DateTime
操作人 CreateBy 否 string

示例

{
"ChannelKey":"web",
"Method":"Member.AcquirePoint",
"BizContent":"{\"OrgId\":2147483644,\"MemberId\":\"113125781\",
\"Point\":\"7\",\"Remark\": \"礼品兑换\",\"PointWay\": \"11\",\"PointChannel\": \"C\"}",
"Sign":"7D59BA1A3C47C7D95B13727FF8498C9A",
"SignType":"MD5",
"Format":"json",
"Charset":"utf-8",
"Version":"1.0",
"Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
bool 成功或失败

示例

{
"Code":10000,
"Message":null,
"SubCode":null,
"SubMessage":null,
"Data":true
}

11.消费积分

Member.ConsumePoint

应用场景

消费积分

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
酒店ID OrgId 是 string
积分消费方式 PointWay 是 string 兑换积分免房：0
兑换部分免房：10
手工调整积分：11
兑换礼品：2
餐费：3
会员升级：4
会员卡：5
积分转出：6
积分抽奖：7
Noshow：9
积分 Point 是 decimal
备注 Remark 是 string
积分产生渠道 PointChannel 是 string 门店：A
网络（网站、微信、手机APP等）：C
其它：Z
抵扣的现金金额 RoomPrice 否 decimal 积分消费时抵扣的现金金额
操作时间 CreateTime 否 DateTime
操作人 CreateBy 否 string

示例

{
"ChannelKey":"web",
"Method":"Member.ConsumePoint",
"BizContent":"{\"OrgId\":2147483644,\"MemberId\":\"113125781\",
\"Point\":\"7\",\"Remark\": \"礼品兑换\",\"PointWay\": \"11\",\"PointChannel\": \"C\"}",
"Sign":"7D59BA1A3C47C7D95B13727FF8498C9A",
"SignType":"MD5",
"Format":"json",
"Charset":"utf-8",
"Version":"1.0",
"Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
bool 成功或失败

示例

{
"Code":10000,
"Message":null,
"SubCode":null,
"SubMessage":null,
"Data":true
}

12.添加储值

Member.AcquireValue

应用场景

添加储值

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
酒店ID OrgId 是 string
添加储值方式 MoneyWay 是 string 购买：A
赠送:B
退现:C
推荐赠送:D
充值金额 Value 是 decimal
储值产生渠道 MoneyChannel 是 string 门店：A
网络（网站、微信、手机APP等）：C
其它：Z

示例

{
     "ChannelKey":"web",
     "Method":"Member.AcquireValue",
     "BizContent":"{\"OrgId\":2147483644,\"MemberId\":\"113125781\",\"Value\":\"200\",
    \"Remark\": \"9256\",\"MoneyWay\": \"A\",\"PointChannel\": \"C\"}",
     "Sign":"752C85FEEBDD029E2E133635C51AD44F",
     "SignType":"MD5",
     "Format":"json",
     "Charset":"utf-8",
     "Version":"1.0",
     "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
bool 成功或失败

示例

{
"Code":10000,
"Message":null,
"SubCode":null,
"SubMessage":null,
"Data":true
}

13.消费储值

Member.ConsumeValue

应用场景

消费积分

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string
酒店ID OrgId 是 string
储值方式 MoneyWay 是 string 房费：A
早餐：B
小商品：C
通讯：D
餐饮：H
会员：M
其他：Z
消费金额 Value 是 decimal
消费产生渠道 MoneyChannel 是 string 门店：A
网络（网站、微信、手机APP等）：C
其它：Z

示例

{
     "ChannelKey":"web",
     "Method":"Member.ConsumeValue",
         "BizContent":"{\"OrgId\":2147483644,\"MemberId\":\"113125781\",\"Value\":\"20\",
    \"Remark\": \"9256\",\"MoneyWay\": \"A\",\"MoneyChannel\": \"C\"}",
     "Sign":"D75C167E3A982219FB084158B0826229",
     "SignType":"MD5",
     "Format":"json",
     "Charset":"utf-8",
     "Version":"1.0",
     "Timestamp":"2017-02-12 14:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
bool 成功或失败

示例

{
"Code":10000,
"Message":null,
"SubCode":null,
"SubMessage":null,
"Data":true
}

14.停用单店会员储值手机验证码

Member.DisableSingleHotelMemberMobileCode

应用场景

停用单店会员储值手机验证码

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店ID OrgId 是 long
是否停用 Disable 是 bool true表示停用手机验证码，false表示不停用手机验证码

示例

                            
                                    {
                                    "ChannelKey":"web",
                                    "Method":"Member.DisableSingleHotelMemberMobileCode",
                                    "BizContent":"{\"OrgId\":2147483644,\"Disable\":true}",
                                    "Sign":"D75C167E3A982219FB084158B0826229",
                                    "SignType":"MD5",
                                    "Format":"json",
                                    "Charset":"utf-8",
                                    "Version":"1.0",
                                    "Timestamp":"2017-02-12 14:12:13"
                                    }

返回结果

字段名 变量名 必填 类型 示例值 描述
Data bool 成功或失败

示例

{
"Code":10000,
"Message":null,
"SubCode":null,
"SubMessage":null,
"Data":true
}

15.升级会员等级

Member.UpgradeMemberLevel

应用场景

升级会员等级

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店ID OrgId 是 long
会员编号 MemberId 是 string
目标等级 TargetLevel 是 string 会员等级，例如 A
升级方式 UpgradeWay 是 string C 表示免费，D 表示现金
创建人 CreatorName 否 string
备注 Remark 否 string

示例

                            
                                    {
                                    "BizContent": "{
                                    \"OwnerId\":1,
                                    \"OrgId\":2147483644,
                                    \"MemberId\":\"000424773\",
                                    \"TargetLevel\":\"A\",
                                    \"UpgradeWay\":\"C\",
                                    \"CreatorName\":\"客服\",
                                    \"Remark\":\"现金升金卡\",
                                    }",
                                    "ChannelKey": "Hotel",
                                    "Charset": "utf-8",
                                    "Domain": "www",
                                    "Format": "json",
                                    "Method": "Member.UpgradeMemberLevel",
                                    "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                                    "SignType": "SHA256",
                                    "Timestamp": "2019-11-27 14:33:00",
                                    "Version": "1.0"
                                    }

返回结果

字段名 变量名 必填 类型 示例值 描述
Data bool 成功或失败

示例

                    
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": true
                            }

16.获取自动升级到下一等级所需的积分、储值和间夜

Member.GetNextLevelCondition

应用场景

供山东沃德调用，展示下一等级剩余间夜等
仅支持升级条件只包含一个条款的配置，如仅配置了通过间夜升级
如果配置了多个条件，如10间夜+1000储值时，此接口返回数据会不准确

请求参数

字段名 变量名 必填 类型 示例值 描述
会员ID MemberId 是 string 000425924 会员的唯一标识符

示例

                            
                                    {
                                    "BizContent": "{
                                    \"MemberId\":\"000424773\",
                                    }",
                                    "ChannelKey": "Hotel",
                                    "Charset": "utf-8",
                                    "Domain": "www",
                                    "Format": "json",
                                    "Method": "Member.GetNextLevelCondition",
                                    "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                                    "SignType": "SHA256",
                                    "Timestamp": "2019-11-27 14:33:00",
                                    "Version": "1.0"
                                    }

返回结果

字段名 变量名 必填 类型 示例值 描述
下一级别编码 NextLevel 否 string A 返回空时表示无法再通过自动升级提升会员等级了
下一级别名称 NextLevelName 否 string 金卡
自动升级到下一级别所需积分 Point 否 decimal 10000
自动升级到下一级别所需间夜 RoomNight 否 decimal 10
自动升级到下一级别所需储值 Value 否 decimal 1000 不支持单店储值
自动升级到下一级别所需累计积分 CreditPoint 否 decimal 10000
自动升级到下一级别所需累计储值 CreditValue 否 decimal 1000 不支持单店储值
当前积分 CurrentPoint 否 decimal 10000
当前间夜 CurrentRoomNight 否 decimal 10
当前储值 CurrentValue 否 decimal 1000 不支持单店储值
当前累计积分 CurrentCreditPoint 否 decimal 10000
当前累计储值 CurrentCreditValue 否 decimal 1000 不支持单店储值

示例

                    
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": {
                                "NextLevel": "B",
                                "NextLevelName": "金卡",
                                "Point": null,
                                "RoomNight": 20.0,
                                "Value": 300.0,
                                "CreditPoint": null,
                                "CreditValue": null,
                                "CurrentPoint": 700.0,
                                "CurrentRoomNight": 0.0,
                                "CurrentValue": 100.0,
                                "CurrentCreditPoint": 1000.0,
                                "CurrentCreditValue": 100.0
                                }
                            }

17.获取自动升级条件

Member.GetAutoUpgradeCondition

应用场景

供山东沃德调用，获取所有有效的会员自动升级条件

请求参数

无

示例

                            
                                    {
                                    "BizContent": "",
                                    "ChannelKey": "Hotel",
                                    "Charset": "utf-8",
                                    "Domain": "www",
                                    "Format": "json",
                                    "Method": "Member.GetNextLevelCondition",
                                    "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                                    "SignType": "SHA256",
                                    "Timestamp": "2019-11-27 14:33:00",
                                    "Version": "1.0"
                                    }

返回结果

字段名 变量名 必填 类型 示例值 描述
原始级别编码 SourceLevel 否 string A
原始级别名称 SourceLevelName 否 string 普卡
目标级别编码 TargetLevel 否 string B
目标级别名称 TargetLevelName 否 string 金卡
升级条款 Clauses 否 AutoUpgradeClause[]
字段名 变量名 必填 类型 示例值 描述
升级条款 Clause 否 string RoomNight RoomNight间夜
Point当前积分
Value当前储值
CreditPoint累计积分
CreditValue累计储值
数量 Amount 否 decimal 10

示例

                        
                            {
                            "Code": 10000,
                            "Message": null,
                            "SubCode": null,
                            "SubMessage": null,
                            "Data": [
                            {
                            "SourceLevel": "A",
                            "SourceLevelName": "普卡",
                            "TargetLevel": "B",
                            "TargetLevelName": "金卡",
                            "Clauses": [
                            {
                            "Clause": "Value",
                            "Amount": 400.0
                            }
                            ]
                            },
                            {
                            "SourceLevel": "A",
                            "SourceLevelName": "普卡",
                            "TargetLevel": "B",
                            "TargetLevelName": "金卡",
                            "Clauses": [
                            {
                            "Clause": "CreditPoint",
                            "Amount": 10000.0
                            },
                            {
                            "Clause": "CreditValue",
                            "Amount": 1000.0
                            }
                            ]
                            }
                            ]
                            }

18.积分兑换礼品

Member.ExchangeGift

应用场景

使用会员积分兑换礼品(目前仅供恒8使用)

请求参数

字段名 变量名 必填 类型 示例值 描述
会员Id MemberId 是 string 000425924 会员的唯一标识符
酒店Id OrgId 是 long 2147483596
收件人信息 Recipients 否 string 自取门店：彩云之南体验店
备注 Remark 否 string
配送方式 DeliveryType 是 string 门店自提：SelfPickup，快递配送：ExpressDelivery
礼品对象集合 Gifts 是 GiftExchangeItemModel[] 注意，类型是数组
字段名 变量名 必填 类型 示例值 描述
兑换礼品的Id GiftItemId 是 long 1341059006349313 礼品的唯一标识符
兑换礼品的数量 Count 是 int 2
兑换使用的积分 Point 是 decimal 2000
兑换礼品的名称 Name 是 string 纸巾

示例

                                
                                    {
                                        "BizContent": "{
                                            \"MemberId\":\"000425924\",
                                            \"OrgId\":2147483596,
                                            \"Recipients\":\"自取门店：彩云之南体验店\",
                                            \"Remark\":\"请至前台领取\",
                                            \"DeliveryType\":\"SelfPickup\",
                                            \"Gifts\":[{
                                                \"GiftItemId\":1341059006349313,
                                                \"Count\":2,
                                                \"Point\":2000,
                                                \"Name\":\"纸巾\"}]
                                        }",
                                        "ChannelKey": "Hotel",
                                        "Charset": "utf-8",
                                        "Domain": "www",
                                        "Format": "json",
                                        "Method": "Member.ExchangeGift",
                                        "Sign": "c4ef6d97d2097c0ef8c1d735d118c05775d0a0923875b4d9f5bf7b7b2a736395",
                                        "SignType": "SHA256",
                                        "Timestamp": "2019-11-27 14:33:00",
                                        "Version": "1.0"
                                    }

返回结果

字段名 变量名 必填 类型 示例值 描述
Data int 积分兑换记录的Id

示例

                        
                            {
                                "Code": 10000,
                                "Message": null,
                                "SubCode": null,
                                "SubMessage": null,
                                "Data": 1825
                            }