Table of Contents

商家 API 接口根地址
阅读 API 功能文档
商家身份鉴权
获取机器人帐号列表
任务回调

回调协议
超时约定

主动推送

推送协议
推送事件

流量风控

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Line开放平台 - 商家接入文档

商家 API 接口根地址

正式环境：https://sdk.line92.top

测试环境：https://test-sdk.line92.top

阅读 API 功能文档

https://test-sdk.line92.top

商家身份鉴权

几乎所有的 API 都要求验证权限，目前只需要简单地在 HTTP 请求头中添加您的商家 Token 即可：

Header Key：Merchant-Token
Header Value：XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX （查看商家 Token）

获取机器人帐号列表

您可以定期调用此接口，将划分给您的机器人账号同步到您自己的数据库：查看接口文档

此接口参数较多，如无特殊需求，只需要传递以下简要参数即可：

{
  "page": 1,  // 页码
  "pageSize": 100 // 页容量
}

响应示例：

{
    "accountSource": "merchantUpload",
    "countryCode": "hk",
    "createdTime": "2024-03-21 09:07:58",
    "deviceId": "172019100035014",
    "enabled": true,
    "heartTime": "2024-03-21 19:15:34",
    "id": "4dd384b9-8849-dc7b-035d-fff9b3b8166f", //此参数为机器人帐号标识，绝大部分API调用都需要传递此参数
    "lineAppVersion": "14.2.0",
    "lineUserId": "ufe67f54b1b9724cfc632a42c286ad2ee",
    "lineUserPassword": "Qa59644231",
    "loginCount": 2,
    "loginType": "protocolCache",
    "modifiedTime": "2024-03-21 19:15:34",
    "nickName": "向馥",
    "onlineStatus": "online",
    "operatingSystem": "android",
    "ownerId": 527666040152069,
    "phone": "85259644231",
    "publicIp": "8.217.233.252"
}

任务回调

接口文档中，未标记为“同步”的接口，默认是异步模式；调用完毕当即只会响应一个 TaskId（任务编号）。

而具体的结果，后续会在任务执行完毕后，通过 HTTP 请求回传到您的 Web 服务器。

回调协议

Request Method	Request Url	Request Header	Request Body
POST	设置用于接收异步任务结果的 URL 地址	Merchant-Token: 您的商家Token Content-Type: application/json	参见 API 文档的响应示例章节

超时约定

系统约定异步任务执行的超时时间为 7200秒，超过此时间任务状态会变更为“完成超时”，为任务终态。

超时任务不再回调任务信息，调用方须在发起任务7200秒后，自行做好超时处理。

主动推送

当与您相关的重要的信息发生了变化，会主动通知到您，以便您对自己的系统做好相应的处理。

通知方式也是通过 HTTP 请求传递到您的 Web 服务器。

推送协议

Request Method	Request Url	Request Header	Request Body
POST	设置用于接收变更事件推送的 URL 地址	Merchant-Token: 您的商家Token Content-Type: application/json	{ type: PushTypes , data: 推送数据 }

推送事件

事件类型	类型描述	推送数据
2000 - RobotHeart	机器人心跳	QueryRobotRsp
2001 - RobotOffline	机器人离线	QueryRobotRsp
2002 - ReceiveMessage	收到消息	ReceiveMessage
2003 - ReadMessage	对方已读	ReadMessage
2004 - InviteMemberToGroup	邀请成员入群	InviteMemberToGroup
2005 - RobotOnline	机器人上线	QueryRobotRsp
2008 - FriendPassed	对方通过好友	FriendPassed
2009 - AddMe	对方添加好友	AddMe
2010 - FriendCreateGroup	好友创建群聊	FriendCreateGroup
2012 - MemberQuiteGroup	群成员退群	MemberQuiteGroup
2013 - NewMemberJoinGroup	新成员入群	NewMemberJoinGroup
2014 - DeleteGroupMember	删除群成员	DeleteGroupMember

流量风控

为了保护账号资源，本系统目前实施的防火墙规则如下：

账号登录接口，相同账号频率5分钟/次，50次/天。
其它功能接口，同账号同功能1分钟/次，100次/天。
同账号，所有接口共200次/天。

当您调用接口的频次超过以上任意规则，会创建任务失败，并当即响应错误信息，响应示例：

{
    "code": 9400,
    "msg": "流量超限 RateLimitConfigInfo { Frequency = 1, TimeWindow = 60, Type = Solo }"
}

此示例表示当前接口调用触发了机器人同一接口每分钟调用不得超过1次的限制。