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

alibaba.lyservice.lippi.session.create (新建会话)

提供给集团的BU,调用该接口,在客户服务的场景下,由客户向客服发起会话请求 dingtalk.oapi.customerservice.session.create

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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_create_session_dto LyCreateSessionDTO 必须 新建会话参数
  • source
  • LySessionSourceDTO
  • 必须
  • 会员来源
  • └ summary
  • String
  • 可选
  • 会话摘要
  • 会话摘要
  • └ channel_avatar_url
  • String
  • 可选
  • https://down.dingtalk.com/ddmedia/iAEKAqNqcGcDAQTNA-gFzQLuBtoAIYQBpAu1l94Cqtvii70ZH-xyKTYDzwAAAWzq1yNYBM30hwcACAA.jpg
  • 发起咨询的头像
  • └ channel_nick
  • String
  • 可选
  • testNick
  • 渠道名称
  • └ cms_id
  • String
  • 可选
  • testCmsId
  • 会员id
  • └ session_source
  • String
  • 必须
  • XSpace
  • 会话来源
  • └ channel_uid
  • String
  • 必须
  • testUid
  • 渠道会员id
  • └ session_end_time
  • Number
  • 可选
  • 1577106264919
  • 会话结束时间
  • └ channel
  • String
  • 必须
  • 0
  • /** * H5页面 */ H5(0), /** * APP内嵌的链接 */ APP(1), /** * 微信小程序 */ WE_CHAT_APPLETS(2), /** * 微信公众号 */ WE_CHAT_OFFICIAL_ACCOUNTS(3)
  • └ session_start_time
  • Number
  • 可选
  • 1577106235000
  • 会话开始时间
  • └ session_status
  • Number
  • 可选
  • 0
  • 0会话中,1已结束
  • └ channel_user_source
  • String
  • 可选
  • 1234
  • 渠道会员所属的系统
  • └ sid
  • String
  • 必须
  • testSessionId
  • 会话id
  • target
  • LySessionTargetDTO
  • 必须
  • 会话目标
  • └ session_source
  • String
  • 必须
  • XSpace
  • 会话来源
  • └ open_instance_id
  • String
  • 可选
  • shop001
  • 实例的id
  • └ ding_corp_id
  • String
  • 可选
  • dingxxx
  • 钉钉的corpId
  • └ production_type
  • Number
  • 可选
  • 1
  • 1,智能客服;1001,经济体版本
  • └ service_id
  • String
  • 必须
  • testServiceId
  • 服务编号
  • └ bu_id
  • String
  • 必须
  • 123
  • 业务单元id
  • └ corp_id
  • String
  • 可选
  • 123
  • 业务单元id

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLyserviceLippiSessionCreateRequest req = new AlibabaLyserviceLippiSessionCreateRequest();
AlibabaLyserviceLippiSessionCreateRequest.LyDingOpenParaDTO obj1 = new AlibabaLyserviceLippiSessionCreateRequest.LyDingOpenParaDTO();
obj1.setIsvOrgId(0L);
obj1.setCorpId("dingxx");
obj1.setTokenGrantType(0L);
obj1.setSuiteKey("xx");
obj1.setOrgId(123L);
req.setLyDingOpenParaDto(obj1);
AlibabaLyserviceLippiSessionCreateRequest.LyCreateSessionDTO obj2 = new AlibabaLyserviceLippiSessionCreateRequest.LyCreateSessionDTO();
AlibabaLyserviceLippiSessionCreateRequest.LySessionSourceDTO obj3 = new AlibabaLyserviceLippiSessionCreateRequest.LySessionSourceDTO();
obj3.setSummary("会话摘要");
obj3.setChannelAvatarUrl("https://down.dingtalk.com/ddmedia/iAEKAqNqcGcDAQTNA-gFzQLuBtoAIYQBpAu1l94Cqtvii70ZH-xyKTYDzwAAAWzq1yNYBM30hwcACAA.jpg");
obj3.setChannelNick("testNick");
obj3.setCmsId("testCmsId");
obj3.setSessionSource("XSpace");
obj3.setChannelUid("testUid");
obj3.setSessionEndTime(1577106264919L);
obj3.setChannel("0");
obj3.setSessionStartTime(1577106235000L);
obj3.setSessionStatus(0L);
obj3.setChannelUserSource("1234");
obj3.setSid("testSessionId");
obj2.setSource(obj3);
AlibabaLyserviceLippiSessionCreateRequest.LySessionTargetDTO obj4 = new AlibabaLyserviceLippiSessionCreateRequest.LySessionTargetDTO();
obj4.setSessionSource("XSpace");
obj4.setOpenInstanceId("shop001");
obj4.setDingCorpId("dingxxx");
obj4.setProductionType(1L);
obj4.setServiceId("testServiceId");
obj4.setBuId("123");
obj4.setCorpId("123");
obj2.setTarget(obj4);
req.setLyCreateSessionDto(obj2);
AlibabaLyserviceLippiSessionCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_lyservice_lippi_session_create_response>
    <result>
        <msg>SYSTEM_ERROR</msg>
        <code>400001</code>
        <success>false</success>
        <data>aa</data>
    </result>
</alibaba_lyservice_lippi_session_create_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

返回
顶部