componentPunchFromPartner.d.ts 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. /**
  2. * 组件打卡开放接口,前置调用位置匹配接口,此接口只提供给ISV运行期间内的多次相同入参调用会被拒绝 请求参数定义
  3. * @apiName biz.pbp.componentPunchFromPartner
  4. */
  5. export interface IBizPbpComponentPunchFromPartnerParams {
  6. /** 业务实例唯一标识 */
  7. bizInstId: string;
  8. /** 业务code */
  9. bizCode: string;
  10. /** 由匹配打卡规则获取到的sessionId */
  11. positionSessionId?: string;
  12. /** 由调用人脸组件获取到的sessionId,本期暂不支持,因此positionSessionId必填 */
  13. faceSessionId?: string;
  14. /** 最长1024个字节 该数据会透传给业务系统,打卡成功后,会将业务系统推送结果进行透传。建议可以传入标识唯一性的id用作上下文处理等 */
  15. extension?: string;
  16. }
  17. /**
  18. * 组件打卡开放接口,前置调用位置匹配接口,此接口只提供给ISV运行期间内的多次相同入参调用会被拒绝 返回结果定义
  19. * @apiName biz.pbp.componentPunchFromPartner
  20. */
  21. export interface IBizPbpComponentPunchFromPartnerResult {
  22. /** 是否成功 */
  23. success: boolean;
  24. /** 接口错误码 */
  25. code: string;
  26. /** 接口错误信息 */
  27. message: string;
  28. /** 推送事件
  29. * "pbp_punch_result":打卡平台打卡结果
  30. * "biz_punch_result": 业务系统打卡结果
  31. **/
  32. event: string;
  33. /** 推送数据,如果为业务系统打卡结果,数据结构由业务方自己定义 为打卡平台打卡结果时,需要自己做反序列化 */
  34. data: string;
  35. }
  36. /**
  37. * 组件打卡开放接口,前置调用位置匹配接口,此接口只提供给ISV运行期间内的多次相同入参调用会被拒绝
  38. * @apiName biz.pbp.componentPunchFromPartner
  39. * @supportVersion ios: 5.1.10 android: 5.1.10
  40. * @author Android:序望,iOS:度尽
  41. */
  42. export declare function componentPunchFromPartner$(params: IBizPbpComponentPunchFromPartnerParams): Promise<IBizPbpComponentPunchFromPartnerResult>;
  43. export default componentPunchFromPartner$;