发送消息
请求方法
POST
请求地址
/messages
请求参数
| 参数 | 参数类型 | 数据类型 | 是否必需 | 描述 |
|---|---|---|---|---|
| msgType | Body | String | 是 | 消息类型 |
| body | Body | String | 是 | 消息内容 参考各类型格式 |
| receiverId | Body | String | 否 | 接收用户id（sessionId为空时必填，默认以receiverId为准） 【最大限制：32字节】 |
| sessionId | Body | Long | 否 | 接收会话id（receiveId为空时必填） |
备注
针对群发消息 ：会存在群空间文件上限限制、校验语音消息、文件消息和视频消息的上限限制，如下：
- 语音消息：时长低于5分钟，大小限制为10M
- 文件消息：单个文件的大小限制为1024M 群文件上限限制（只针对群）、磁盘空间限制
- 视频消息：时长低于5分钟，大小限制为300M
- 图片消息：单张图片大小限制为20M
HTTP状态码
| 返回值 | 描述 |
|---|---|
| 200 | 操作成功，详见响应参数 |
| 400 | 客户端传参异常 |
| 401 | 鉴权失败 |
| 500 | 服务端异常 |
响应参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
| msgId | Long | 消息id |
| sessionId | Long | 会话id |
| senderId | String | 发送者id 发送者，可以是用户或机器人 |
| receiverId | String | 接收者id |
| bornTime | Long | 消息生成时间 |
请求消息示例
POST /open/api/v2/messages HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"msgType": "text",
"body": "hello",
"receiverId": "8d07a56207074d26b61026099625b9e2",
"sessionId": 123456789
}
响应消息示例
{
"msgId": 1,
"sessionId": 123456789,
"senderId": "8d07a56207074d26b61026099625b9e2",
"receiverId": "8d07a56207074d26b61026099625b9e2"
"bornTime": "1623895862000"
}