标准报文

简介

该接口用于需要支撑平台代为验证的电子凭证生成和下发。

请求报文

  1. <?xml version="1.0" encoding="GBK"?>
  2. <SubmitVerifyReq>
  3. <SystemID>2200</SystemID>
  4. <ISSPID>00000061</ISSPID>
  5. <TransactionID>987465</TransactionID>
  6. <Recipients>
  7. <Number>13900000000</Number>
  8. </Recipients>
  9. <SendClass>SAM</SendClass>
  10. <Messages>
  11. <Sms>
  12. <Text>这里是短信内容</Text>
  13. </Sms>
  14. <Mms>
  15. <Subject>这里是彩信标</Subject>
  16. <Text>这里是彩信内容</Text>
  17. </Mms>
  18. </Messages>
  19. <pin_setting>
  20. <pin_md5>12345678901234567890123456789012</pin_md5>
  21. <pin_try_times>3</pin_try_times>
  22. </pin_setting>
  23. <ActivityInfo>
  24. <ActivityID>11080508951</ActivityID>
  25. <BeginTime>20111010000000</BeginTime>
  26. <EndTime>20111210235959</EndTime>
  27. <OrgTimes>1</OrgTimes>
  28. <OrgAmt>100</OrgAmt>
  29. <PrintText>10元代金券一张\r谢谢使用!</PrintText>
  30. </ActivityInfo>
  31. <BmpFlag>0</BmpFlag>
  32. <CustomArea></CustomArea>
  33. </SubmitVerifyReq>

请求参数

XML元素类型意义说明是否必填
SystemIDString(4)接入系统号支撑平台提供必填
ISSPIDString(8)业务商号支撑平台提供必填
TransactionIDString(32)请求流水号请求流水号用于关联请求与响应,并且防止请求重播。作为请求唯一标识不能重复,最长32位。特别注意:在未收到响应报文时(超时),不能确认支撑平台是否已经处理成功,原报文应重试几次,该字段值不能改变,如改变则认为新交易,可能造成多发。必填
Recipients
->Number
String(64)条码凭证接收号如手机号必填
SendClassString(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_timesNumber(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谢谢使用!必填
BmpFlagChar(1)是否需要返回图片信息0:不返回
1:返回DM码
2:返回QR码
SendClas为IMG且BmpFlag不为2,则以DM码返回。默认值1。其他类型值为1,2时才返回。
可选
CustomAreaString(64)定制区域预留可选

应答报文

  1. <?xml version="1.0" encoding="GBK"?>
  2. <SubmitVerifyRes>
  3. <ISSPID>00000061</ISSPID>
  4. <TransactionID>987465</TransactionID>
  5. <Status>
  6. <StatusCode>0000</StatusCode>
  7. <StatusText>成功</StatusText>
  8. </Status>
  9. <MessageID>20111219151034009727</MessageID>
  10. <AssistNumber></AssistNumber>
  11. <Wbmp>AAAgIP/////////////////////1VVVX9Sou /YA74/xETIj9UrSD/D9pQP0mrQP8/Zew/eEjO/wph8L82Wrz/WVG9P208XX8krBK/THakf1Rnjz87Gh7/BHMAv3Ck7H8ahPI/Z8wof1NenD8kZ9B/IVIYP36MNP8AAAA///////////</Wbmp>
  12. </SubmitVerifyRes>

应答参数

XML元素类型意义说明是否必填
TransactionIDString(32)请求流水号与请求报文xml中的元素相同必填
ISSPIDString(8)接入SP的ID号,为翼码凭证平台提供的业务商机构号与请求报文xml中的元素相同必填
Status->StatusCodeNumber(4)处理应答码成功为0000,非0000失败。详见:返回码说明必填
Status->StatusTextString(512)处理应答解释详见:返回码说明必填
WbmpStringWbmp图片数据请求BmpFlag为1或者SendClass为IMG时返回可选
AssistNumberString(16)返回的辅助码需支撑平台活动上进行设置,默认不返回。可选配置,返回后4位或者全部返回可选
MessageIDString(20)信息标识由翼码凭证平台产生。失败时,无此值。可选

简易报文

简介

该接口用于需要支撑平台代为验证的电子凭证生成和下发。与标准接口的区别在于,参数都配置在支撑平台活动上,凭证生成下发时取平台的默认值进行发送。

请求报文

  1. <?xml version="1.0" encoding="GBK"?>
  2. <SimpleSubmitVerifyReq>
  3. <SystemID>2200</SystemID>
  4. <ISSPID>00000061</ISSPID>
  5. <TransactionID>21242</TransactionID>
  6. <Recipients>
  7. <Number>13900000000</Number>
  8. </Recipients>
  9. <ActivityInfo>
  10. <ActivityID>11080508951</ActivityID>
  11. </ActivityInfo>
  12. </SimpleSubmitVerifyReq>

请求参数

XML元素类型意义说明是否必填
SystemIDString(4)接入平台号同标准接口必填
ISSPIDString(8)接入SP的ID号,为翼码凭证平台提供的业务商机构号同标准接口必填
TransactionIDString(32)凭证发送单号同标准接口必填
Recipients
->Number
String(64)条码凭证接收号同标准接口必填
ActivityInfo
->ActivityID
String(11)活动号同标准接口必填

应答报文

  1. <?xml version="1.0" encoding="GBK"?>
  2. <SimpleSubmitVerifyRes>
  3. <ISSPID>00000061</ISSPID>
  4. <TransactionID>21242</TransactionID>
  5. <Status>
  6. <StatusCode>0000</StatusCode>
  7. <StatusText>成功</StatusText>
  8. </Status>
  9. <MessageID>20111219184047009818</MessageID>
  10. <AssistNumber></AssistNumber>
  11. <Wbmp></Wbmp>
  12. </SimpleSubmitVerifyRes>

应答参数

XML元素类型意义说明是否必填
ISSPIDString(8)接入SP的ID号,为翼码凭证平台的提供的业务商机构号同标准接口必填
TransactionIDString(32)凭证发送单号同标准接口必填
Status-> StatusCodeString(4)处理应答码同标准接口 详见:返回码说明必填
Status-> StatusTextString(512)处理应答解释同标准接口 详见:返回码说明必填
MessageIDString(20)信息标识同标准接口可选
AssistNumberString(16)返回的辅助码同标准接口可选
WbmpString(1024)Wbmp图片数据配置的发送类型为IMG时返回可选