SAAS Line API send - nxtele/http-api-document GitHub Wiki

发送消息

通过API发起line号码消息发送服务

  • URL：https://api.nxcloud.com/saas/line/send
  • Method：POST
  • Content-Type：application/json
  • 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

header参数：

参数名 类型 必选 示例值 说明
accessKey String 是 fme2na3kdi3ki 用户身份标识
ts String 是 1655710885431 当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType String 是 7 Line业务类型，取固定值“7”
action String 是 mt Line业务操作，取固定值“mt”
sign String 是 6e9506557d1f289501d333ee2c361111 API入参参数签名，公共约定

body参数：

参数名 类型 必选 示例值 说明
tenant_id Long 是 1 租户ID
appkey String 是 pem28kje 应用appkey
to String 是 U44d64355f3d939f4db74649d82d25xxx 消息接收方的channelId。如U44d64355f3d939f4db74649d82d25xxx
type Integer 是 1 支持以下消息类型的发送：
1:文本
3:图片
4:视频
5:语音
filename String 否 - 仅消息为图片、视频、语音时为必须
originalContentUrl String 否 - 媒体文件 url，仅消息为图片、视频、语音时为必须
content String 否 - 仅消息包含文本时为必须
previewImageUrl String 否 - 预览图，仅消息为视频时必须
duration Long 否 - 单位为毫秒,仅消息为语音时必须

消息类型

  • 1: 文本
  • 3: 图片
  • 4: 视频
  • 5: 语音

请求示例

文本

{
    "tenant_id": 123,
    "appkey": "Exxx",
    "to": "U44d64355f3d939f4db74649d82d25xxx",
    "type": 1,
    "content": "普通文本"
}

图片

{
    "tenant_id": 123,
    "appkey": "Exxx",
    "to": "U44d64355f3d939f4db74649d82d25xxx",
    "type": 3,
    "filename": "7PSg8pGsIuWfHJZ.jpg",
    "originalContentUrl": "https://nxtele-hk.oss-cn-hongkong.aliyuncs.com/6.5M.jpeg?Expires=1706089776&OSSAccessKeyId=TMP.3KhCyAyQVWhZt6N1prT69KjWMhXRDFQ5Ad5bj4BNkAx8TC3RuvXofqDdgunV9gQtDJk91X8n7kuypNJRBTJPhtqTcViaa5&Signature=%2FHvdJziTm2eaeqvTW7Y5VVxA5ZA%3D"
}

视频

{
    "tenant_id": 123,
    "appkey": "Exxx",
    "to": "U44d64355f3d939f4db74649d82d25xxx",
    "type": 4,
    "filename": "7PSg8pGsIuWfHJZ.mp4",
    "originalContentUrl": "https://goss.oss-cn-hongkong.aliyuncs.com/0c803030-17e2-11ef-ae66-d9bd85096f5b?Expires=1716870105&OSSAccessKeyId=LTAI5tBrjWM5EyDe6MA5uc7z&Signature=GoKsgcTERGGG3UNv06plqo84Zw2SI%3D",
"previewImageUrl": "https://nxtele-hk.oss-cn-hongkong.aliyuncs.com/6.5M.jpeg?Expires=1706089776&OSSAccessKeyId=TMP.3KhCyAyQVWhZt6N1prT69KjWMhXRDFQ5Ad5bj4BNkAx8TC3RuvXofqDdgunV9gQtDJk91X8n7kuypNJRBTJPhtqTcViaa5&Signature=%2FHvdJziTm2eaeqvTW7Y5VVxA5ZA%3D"
}

语音

{
    "tenant_id": 123,
    "appkey": "Exxx",
    "to": "U44d64355f3d939f4db74649d82d25xxx",
    "type": 5,
    "filename": "7PSg8pGsIuWfHJZ.m4a",
    "originalContentUrl": "https://goss.oss-cn-hongkong.aliyuncs.com/0c803030-17e2-11ef-ae66-d9bd85096f5b?Expires=1716870105&OSSAccessKeyId=LTAI5tBrjWM5EyDe6MA5uc7z&Signature=GoKsgcTERGGG3UNv06plqo84Zw2SI%3D",
"duration": 12000
}

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
message String 请求结果说明
traceId String 链路追踪ID
  • data object参数：
参数名 类型 说明
message_id String 消息ID

响应示例

成功示例

{
	"code": 0,
	"message": "",
	"data": null,
	"traceId": "56bf81643292cd6a89ecde64ae00db13"
}

失败示例

{
    "code": -1,
    "message": "Failure",
    "traceId": "77f8709b545f4fee93fd7f098be9df04"
}

响应码说明

Code Message Solution
0 Success -
-1 Failure 请联系技术人员排除问题
1000~100X Authentication failed 详情查看API鉴权部分
9000 Request parameter error 参数缺失，请检查必须的参数
9001 System business error 系统业务错误，请联系技术人员排除问题
9999 Unknown error 请联系技术人员排除问题
⚠️ **GitHub.com Fallback** ⚠️