# 平台对外接口调用协议定义(HPS)

接口通过HPS(http get + MD5验签)协议接入,需要授权访问。授权联系人:王智涛; 接口联系人:杨文伟

hps协议接入标准请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
merchant_name 接入用户名,接入用户名从接入平台获取 query true string
signature_method 签名方法,目前固定传 MD5 query true string
signature 签名(详见 HPS请求签名算法) query true string
timestamp 时间戳 query true string
xxx 业务参数 query true int

HPS请求签名算法

  1. 当前请求参数名的字母序进行升序排列(排序时区分大小写,signature和value为空的参数不参与签名);
  2. 将所有参数-值组合以 key=value 的形式拼成一个新字符串,不同参数值之间没有任何分隔符;
  3. 最后加上对应的签名密钥 secretKey(此密钥在接入时由王智涛方提供给游戏相关接入人员) 后进行MD5哈希运算。如MD5方法的输入的字符串为:key1=value1key2=value2secretKey;

# 短信下行接口说明(templateSubmit)

接口地址:/smg/mt/templateSubmit (完整接口地址,请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

短信下行接口说明

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
client_id 应用 ID query true string 服务平台的应用管理中获取
seq 请求唯一标识 query true string 最长 32 位,由商户生成
pid 业务场景编号 query true string 商户在某应用下自行创建的业务场景编号
templateId 短信模板编号 query true string 商户在某业务场景下自行创建的短信模板的编号
(短信模板必须审核通过后,才能使用)
phone 手机号 query true string 短信接收的手机号码。国内为 11 位;
国际格式:“+”+国家代码+本国号
msg 变量值串 query true string 若短信模板中无变量,msg 值非空任意值,如 test。
短信内容就是模板内容。
若短信模板中有变量,msg 值为各变量值按变量
先后序幵用"||" 分隔的组合串,
例:msg=xxxx||yyy||zzzzz。
短信内容由模板及变量值共同组成。
注:msg 值含中文时,url生成时msg值需要 UTF8 编码;生成签名时无需编码
smsNoEx 特服号扩展 query false string 可选参数。需申请后,方可有效。最长 8 位,建议 3 位。
type 短信类型 query false string 可选参数。如 type 值非空,如 voice 是语音短信

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  failReason 返回信息 string
  seq 请求唯一标示 string
  orderId 包序号(成功才有返回) string
  bills 话单数(成功才有返回) int
  youniFlag 是否通过 youni 发送:0-否,1-是(成功才有返回) int

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
        "resultCode": 0,
	    "failReason": "成功",
		"seq": "6a145ed9dc544051bfc65cf8926ab830",
		"orderId": "300520240423012310001001",
		"bills": 1,
		"youniFlag": 0
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
Last Updated: 4/25/2024, 2:05:40 AM