API文档

消息接口

接口列表

接口名称 接口方法 说明
1.发送短信 Message.SendSms 在客人办理预定、入住或者退房等业务后即时发送短信告知客户办理业务的相关信息。
2.向PMS前台推送消息 Message.PushMessageToPmsFrontend 向PMS前台推送消息。

1.发送短信

Message.SendSms

应用场景

在客人办理预定、入住或者退房等业务后即时发送短信告知客户办理业务的相关信息。

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店ID OrgId 是 long
酒店名称 OrgName 否 string
酒店地址 OrgAddress 否 string
酒店电话 OrgPhone 否 string
入店时间 BeginTime 否 string
离店时间 EndTime 否 string
订单号 OrderNumber 否 string
房间数 Rooms 否 string
房费 TotalValue 否 string
会员名称 MemberName 否 string
短信发送时间 EventTime 否 string UTC时间
短信金额 ValueAmount 否 string
储值金额 ValueBalance 否 string
手机号 Mobile 是 string
事件类型 EventCode 是 string 1 新增订单 AddNewOrder = 1 取消订单 CancelOrder = 2 入住 Checkin = 3 离店 Checkout = 4 找回密码（） FindPassword = 21
备注信息 Remark 是 string

示例

{
     "ChannelKey": "web",
     "Method": "Message.SendSms",
     "BizContent":"{\"GroupName\":\"\",\"OrgName\":\"cuiqiang\",\"OrgAddress\":\"上海闵行\",
     \"OrgPhone\":\"021-52786259\",\"BeginTime\":\"2017-12-18 10:12:13\",
     \"EndTime\":\"2017-12-19 10:12:13\",\"OrderNumber\":\"21245872369625\",
     \"Rooms\":\"1\",\"TotalValue\":\"200\",\"MemberName\":\"\",\"EventTime\":\"2017-12-18 10:12:13\",
     \"ValueAmount\":\"0.1\",\"ValueBalance\":\"10\",\"Mobile\":\"18601700926\",
     \"EventCode\":\"AddNewOrder\",\"Remark\":\"\"}",
     "Sign": "1B25F8759E9C857E962D8EFAA575B0AB",
     "SignType": "MD5",
     "Format": "json",
     "Charset": "utf-8",
     "Version": "1.0",
     "Timestamp": "2017-12-18 10:12:13"
}

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

{
    "GroupName":"",
    "OrgName":"cuiqiang",
    "OrgAddress":"上海闵行",
    "OrgPhone":"021-52786259",
    "BeginTime":"2017-12-18 10:12:13",
    "EndTime":"2017-12-19 10:12:13",
    "OrderNumber":"21245872369625",
    "Rooms":"1",
    "TotalValue":"200",
    "MemberName":"",
    "EventTime":"2017-12-18 10:12:13",
    "ValueAmount":"0.1",
    "ValueBalance":"10",
    "Mobile":"18601700926",
    "EventCode":"AddNewOrder",
    "Remark":""
}

返回结果

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

示例

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

2.向PMS前台推送消息

Message.PushMessageToPmsFrontend

应用场景

向PMS前台推送消息。

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店ID OrgId 是 long
消息类型 MessageType 否 string 暂时无用
消息内容 Content 是 string
消息弹出框是否需要手工确认 IsNeedConfirm 否 bool 暂时无用
显示的时长 DisplayDurationInMilliseconds 否 int 消息在界面上显示的时间单位：毫秒 暂时无用

示例

{
     "ChannelKey": "web",
     "Method": "Message.PushMessageToPmsFrontend",
     "BizContent":"{\"OrgId\":2147483644,\"MessageType\":null,\"Content\":\"美团订单来了\"
                        ,\"IsNeedConfirm\":false,\"DisplayDurationInMilliseconds\":0}",
     "Sign": "1B25F8759E9C857E962D8EFAA575B0AB",
     "SignType": "MD5",
     "Format": "json",
     "Charset": "utf-8",
     "Version": "1.0",
     "Timestamp": "2018-12-18 10:12:13"
}

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

{
    "OrgId":2147483644,
    "MessageType":null,
    "Content":"您有新的订单",
    "IsNeedConfirm":false,
    "DisplayDurationInMilliseconds":0
}

返回结果

字段名 变量名 必填 类型 示例值 描述
发送状态 bool true，false 成功或失败

示例

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