文档中心 > API类目 > 瓴羊客服云

alibaba.lyservice.lippi.session.close (关闭会话)

提供给集团的BU,调用该接口,在客户服务的场景下,由客户主动关闭会话等场景 dingtalk.oapi.customerservice.session.close

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
ly_ding_open_para_dto LyDingOpenParaDTO 可选 开放平台默认参数
  • └ isv_org_id
  • Number
  • 可选
  • 0
  • 当tokenGrantType=1时,isvOrgId才会被赋值,此值表示调用方是ISV时,ISV在钉钉上的企业ID
  • └ corp_id
  • String
  • 可选
  • dingxx
  • 表示当前token所属的企业对外开放的ID
  • └ token_grant_type
  • Number
  • 可选
  • 0
  • 0为证书类型,表示当前token是企业自己的,本次调用方是企业;1为授权类型,表示当前token是企业授权给ISV的,本次调用方是ISV
  • └ suite_key
  • String
  • 可选
  • xx
  • tokenGrantType=1时,suiteKey才会被赋值
  • └ org_id
  • Number
  • 可选
  • 123
  • 表示当前token所属的企业ID
ly_close_session_dto LyCloseSessionDTO 必须 关闭会话
  • └ reason
  • String
  • 必须
  • memberIsSilent
  • 关闭原因,memberIsSilent/heartBeatBreak/memberCloseTheSession
  • └ session_source
  • String
  • 必须
  • XSpace
  • 会话来源
  • └ open_instance_id
  • String
  • 可选
  • shop001
  • 实例id
  • └ ding_corp_id
  • String
  • 可选
  • dingxxx
  • 钉钉的corpId
  • └ production_type
  • Number
  • 可选
  • 1
  • 1,智能客服;1001,经济体版本
  • └ operator_type
  • String
  • 可选
  • 4
  • 4,小二;1,会员
  • └ service_id
  • String
  • 可选
  • 80003
  • 客服的id
  • └ operator_id
  • String
  • 必须
  • testOperatorId
  • 操作者id
  • └ sid
  • String
  • 必须
  • testSessionId
  • 会话id
  • └ bu_id
  • String
  • 必须
  • 100
  • 客服所在bu

响应参数

名称 类型 示例值 描述
result ResultDO 结果
  • └ msg
  • String
  • SYSTEM_ERROR
  • 错误信息
  • └ code
  • String
  • 400001
  • 错误码
  • └ success
  • Boolean
  • false
  • 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLyserviceLippiSessionCloseRequest req = new AlibabaLyserviceLippiSessionCloseRequest();
AlibabaLyserviceLippiSessionCloseRequest.LyDingOpenParaDTO obj1 = new AlibabaLyserviceLippiSessionCloseRequest.LyDingOpenParaDTO();
obj1.setIsvOrgId(0L);
obj1.setCorpId("dingxx");
obj1.setTokenGrantType(0L);
obj1.setSuiteKey("xx");
obj1.setOrgId(123L);
req.setLyDingOpenParaDto(obj1);
AlibabaLyserviceLippiSessionCloseRequest.LyCloseSessionDTO obj2 = new AlibabaLyserviceLippiSessionCloseRequest.LyCloseSessionDTO();
obj2.setReason("memberIsSilent");
obj2.setSessionSource("XSpace");
obj2.setOpenInstanceId("shop001");
obj2.setDingCorpId("dingxxx");
obj2.setProductionType(1L);
obj2.setOperatorType("4");
obj2.setServiceId("80003");
obj2.setOperatorId("testOperatorId");
obj2.setSid("testSessionId");
obj2.setBuId("100");
req.setLyCloseSessionDto(obj2);
AlibabaLyserviceLippiSessionCloseResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_lyservice_lippi_session_close_response>
    <result>
        <msg>SYSTEM_ERROR</msg>
        <code>400001</code>
        <success>false</success>
    </result>
</alibaba_lyservice_lippi_session_close_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部