-
Notifications
You must be signed in to change notification settings - Fork 6
SAAS Line API send
zjc1750514326 edited this page Jun 18, 2024
·
15 revisions
通过API发起line号码消息发送服务
- URL:
https://api.nxcloud.com/saas/line/send
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
鉴权规则请参考地址:API接口调用约定
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
accessKey | String | 是 | fme2na3kdi3ki | 用户身份标识 |
ts | String | 是 | 1655710885431 | 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType | String | 是 | 7 | Line业务类型,取固定值“7” |
action | String | 是 | mt | Line业务操作,取固定值“mt” |
sign | String | 是 | 6e9506557d1f289501d333ee2c361111 | API入参参数签名,公共约定 |
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
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 | 请联系技术人员排除问题 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent(对外api)