标准报文
简介
该接口用于需要支撑平台代为验证的电子凭证生成和下发。
请求报文
<?xml version="1.0" encoding="GBK"?>
<SubmitVerifyReq>
<SystemID>2200</SystemID>
<ISSPID>00000061</ISSPID>
<TransactionID>987465</TransactionID>
<Recipients>
<Number>13900000000</Number>
</Recipients>
<SendClass>SAM</SendClass>
<Messages>
<Sms>
<Text>这里是短信内容</Text>
</Sms>
<Mms>
<Subject>这里是彩信标</Subject>
<Text>这里是彩信内容</Text>
</Mms>
</Messages>
<pin_setting>
<pin_md5>12345678901234567890123456789012</pin_md5>
<pin_try_times>3</pin_try_times>
</pin_setting>
<ActivityInfo>
<ActivityID>11080508951</ActivityID>
<BeginTime>20111010000000</BeginTime>
<EndTime>20111210235959</EndTime>
<OrgTimes>1</OrgTimes>
<OrgAmt>100</OrgAmt>
<PrintText>10元代金券一张\r谢谢使用!</PrintText>
</ActivityInfo>
<BmpFlag>0</BmpFlag>
<CustomArea></CustomArea>
</SubmitVerifyReq>
请求参数
XML元素 | 类型 | 意义 | 说明 | 是否必填 |
---|---|---|---|---|
SystemID | String(4) | 接入系统号 | 支撑平台提供 | 必填 |
ISSPID | String(8) | 业务商号 | 支撑平台提供 | 必填 |
TransactionID | String(32) | 请求流水号 | 请求流水号用于关联请求与响应,并且防止请求重播。作为请求唯一标识不能重复,最长32位。特别注意:在未收到响应报文时(超时),不能确认支撑平台是否已经处理成功,原报文应重试几次,该字段值不能改变,如改变则认为新交易,可能造成多发。 | 必填 |
Recipients ->Number | String(64) | 条码凭证接收号 | 如手机号 | 必填 |
SendClass | String(3) | 发送类型 | SAM:先彩信发送(彩信未送达则自动发送一条短信);SMS:短信发送;MMS:彩信发送;IMG:制图不下发;BMS:短彩并行下发 | 必填 |
Messages ->Sms->Text | String(80) | 短信内容 | 最长不超过80个字 (汉字、数字、字母都算一个字) | 一般必填,但SendClass 为IMG可以不填 |
Messages ->Mms->Subject | String(20) | 彩信标题 | 最长不超过20字节(汉字算2个字节,数字、字母算1个字)(下发彩信时做为彩信标题) | 一般必填,但SendClass 为IMG可以不填 |
Messages ->Mms->Text | String(500) | 彩信内容 | 如果不填则为短信内容。最长不超过500字(汉字算2个字节,数字、字母算1个字) | 可选 |
pin_setting ->pin_md5 | String(32) | 凭证使用密码 | 凭证使用时可选输入密码进行验证交易,该字段输入密码的md5值。如密码111111 md5值为96e79218965eb72c92a549dd5a330112 | 可选 |
pin_setting->pin_try_times | Number(4) | 连续密码错误最大次数 | 密码连续错误次数达到该字段值,则条码锁定,通过客服进行解锁后才能使用 | 可选 |
ActivityInfo ->ActivityID | String(11) | 活动号 | 支撑平台分配 | 必填 |
ActivityInfo ->BeginTime | String(14) | 开始时间 | 条码开始使用时间 | 可选 |
ActivityInfo ->EndTime | String(14) | 结束时间 | 条码结束使用时间 | 可选 |
ActivityInfo ->OrgTimes | Number(6) | 活动可使用次数 | 一个条码可以在该发码活动中最多可使用次数,如果活动按金额验证,则填入0。如果活动为次数验证,则必须大于0 | 必填 |
ActivityInfo ->OrgAmt | Number(8,2) | 活动可使用金额 | 一个条码可以在该发码活动中最多可使用金额,如果活动为按次数验证,该字段仅做打印和统计用。如果活动为金额验证,则必须大于0,金额单位为元。1.15表示1元1角5分。 | 必填 |
ActivityInfo ->PrintText | String(100) | 活动打印内容 | 小票打印内容,最长不超过100个字(汉字算2个字节,数字、字母算1个字),如果要换行使用\r ,如:10元代金券一张\r谢谢使用! | 必填 |
BmpFlag | Char(1) | 是否需要返回图片信息 | 0:不返回 1:返回DM码 2:返回QR码 SendClas为IMG且BmpFlag不为2,则以DM码返回。默认值1。其他类型值为1,2时才返回。 | 可选 |
CustomArea | String(64) | 定制区域 | 预留 | 可选 |
应答报文
<?xml version="1.0" encoding="GBK"?>
<SubmitVerifyRes>
<ISSPID>00000061</ISSPID>
<TransactionID>987465</TransactionID>
<Status>
<StatusCode>0000</StatusCode>
<StatusText>成功</StatusText>
</Status>
<MessageID>20111219151034009727</MessageID>
<AssistNumber></AssistNumber>
<Wbmp>AAAgIP/////////////////////1VVVX9Sou /YA74/xETIj9UrSD/D9pQP0mrQP8/Zew/eEjO/wph8L82Wrz/WVG9P208XX8krBK/THakf1Rnjz87Gh7/BHMAv3Ck7H8ahPI/Z8wof1NenD8kZ9B/IVIYP36MNP8AAAA///////////</Wbmp>
</SubmitVerifyRes>
应答参数
XML元素 | 类型 | 意义 | 说明 | 是否必填 |
---|---|---|---|---|
TransactionID | String(32) | 请求流水号 | 与请求报文xml中的元素相同 | 必填 |
ISSPID | String(8) | 接入SP的ID号,为翼码凭证平台提供的业务商机构号 | 与请求报文xml中的元素相同 | 必填 |
Status->StatusCode | Number(4) | 处理应答码 | 成功为0000,非0000失败。详见:返回码说明 | 必填 |
Status->StatusText | String(512) | 处理应答解释 | 详见:返回码说明 | 必填 |
Wbmp | String | Wbmp图片数据 | 请求BmpFlag为1或者SendClass为IMG时返回 | 可选 |
AssistNumber | String(16) | 返回的辅助码 | 需支撑平台活动上进行设置,默认不返回。可选配置,返回后4位或者全部返回 | 可选 |
MessageID | String(20) | 信息标识 | 由翼码凭证平台产生。失败时,无此值。 | 可选 |
简易报文
简介
该接口用于需要支撑平台代为验证的电子凭证生成和下发。与标准接口的区别在于,参数都配置在支撑平台活动上,凭证生成下发时取平台的默认值进行发送。
请求报文
<?xml version="1.0" encoding="GBK"?>
<SimpleSubmitVerifyReq>
<SystemID>2200</SystemID>
<ISSPID>00000061</ISSPID>
<TransactionID>21242</TransactionID>
<Recipients>
<Number>13900000000</Number>
</Recipients>
<ActivityInfo>
<ActivityID>11080508951</ActivityID>
</ActivityInfo>
</SimpleSubmitVerifyReq>
请求参数
XML元素 | 类型 | 意义 | 说明 | 是否必填 |
---|---|---|---|---|
SystemID | String(4) | 接入平台号 | 同标准接口 | 必填 |
ISSPID | String(8) | 接入SP的ID号,为翼码凭证平台提供的业务商机构号 | 同标准接口 | 必填 |
TransactionID | String(32) | 凭证发送单号 | 同标准接口 | 必填 |
Recipients ->Number | String(64) | 条码凭证接收号 | 同标准接口 | 必填 |
ActivityInfo ->ActivityID | String(11) | 活动号 | 同标准接口 | 必填 |
应答报文
<?xml version="1.0" encoding="GBK"?>
<SimpleSubmitVerifyRes>
<ISSPID>00000061</ISSPID>
<TransactionID>21242</TransactionID>
<Status>
<StatusCode>0000</StatusCode>
<StatusText>成功</StatusText>
</Status>
<MessageID>20111219184047009818</MessageID>
<AssistNumber></AssistNumber>
<Wbmp></Wbmp>
</SimpleSubmitVerifyRes>
应答参数
XML元素 | 类型 | 意义 | 说明 | 是否必填 |
---|---|---|---|---|
ISSPID | String(8) | 接入SP的ID号,为翼码凭证平台的提供的业务商机构号 | 同标准接口 | 必填 |
TransactionID | String(32) | 凭证发送单号 | 同标准接口 | 必填 |
Status-> StatusCode | String(4) | 处理应答码 | 同标准接口 详见:返回码说明 | 必填 |
Status-> StatusText | String(512) | 处理应答解释 | 同标准接口 详见:返回码说明 | 必填 |
MessageID | String(20) | 信息标识 | 同标准接口 | 可选 |
AssistNumber | String(16) | 返回的辅助码 | 同标准接口 | 可选 |
Wbmp | String(1024) | Wbmp图片数据 | 配置的发送类型为IMG时返回 | 可选 |