消息处理
删除用户的指定会话
基本信息
Path: /message/conversation
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
conversation_id | 是 | conversation_id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
发送已读回执
基本信息
Path: /message/ack
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
conversation_id | 是 | conversation_id | |
device_sn | 是 | device_sn | |
msg_id | 是 | msg_id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
发送消息
基本信息
Path: /message/send
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
attachment | string | 非必须 | |||
config | string | 非必须 | |||
content | string | 非必须 | |||
content_type | integer | 必须 | 消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7; | 最大值: 7 最小值: 0 format: int32 | |
ext | string | 非必须 | |||
from_user_id | integer | 非必须 | 发送者的用户ID | format: int64 | |
targets | integer [] | 必须 | 接收用户ID或群ID | item 类型: integer | |
├─ | 非必须 | ||||
transaction_id | integer | 非必须 | 交易ID,用于消息去重 | format: int64 | |
type | integer | 必须 | 目标类型,1 - 普通用户,2 - 群组 | 最大值: 2 最小值: 1 format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
发送消息
基本信息
Path: /message/send
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
attachment | string | 非必须 | |||
config | string | 非必须 | |||
content | string | 非必须 | |||
content_type | integer | 必须 | 消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7; | 最大值: 7 最小值: 0 format: int32 | |
ext | string | 非必须 | |||
from_user_id | integer | 非必须 | 发送者的用户ID | format: int64 | |
targets | integer [] | 必须 | 接收用户ID或群ID | item 类型: integer | |
├─ | 非必须 | ||||
transaction_id | integer | 非必须 | 交易ID,用于消息去重 | format: int64 | |
type | integer | 必须 | 目标类型,1 - 普通用户,2 - 群组 | 最大值: 2 最小值: 1 format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
发送系统通知
基本信息
Path: /message/notify
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
attachment | string | 非必须 | |||
config | string | 非必须 | |||
content | string | 非必须 | |||
content_type | integer | 必须 | 消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7; | 最大值: 7 最小值: 0 format: int32 | |
ext | string | 非必须 | |||
from_user_id | integer | 非必须 | 发送者的用户ID | format: int64 | |
targets | integer [] | 必须 | 接收用户ID或群ID | item 类型: integer | |
├─ | 非必须 | ||||
transaction_id | integer | 非必须 | 交易ID,用于消息去重 | format: int64 | |
type | integer | 必须 | 目标类型,1 - 普通用户,2 - 群组 | 最大值: 2 最小值: 1 format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
发送系统通知
基本信息
Path: /message/notify
Method: PUT
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
attachment | string | 非必须 | |||
config | string | 非必须 | |||
content | string | 非必须 | |||
content_type | integer | 必须 | 消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7; | 最大值: 7 最小值: 0 format: int32 | |
ext | string | 非必须 | |||
from_user_id | integer | 非必须 | 发送者的用户ID | format: int64 | |
targets | integer [] | 必须 | 接收用户ID或群ID | item 类型: integer | |
├─ | 非必须 | ||||
transaction_id | integer | 非必须 | 交易ID,用于消息去重 | format: int64 | |
type | integer | 必须 | 目标类型,1 - 普通用户,2 - 群组 | 最大值: 2 最小值: 1 format: int32 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | boolean | 非必须 | 结果数据 | ||
message | string | 非必须 | 错误信息,如果成功,该项为null |
取指定会话的消息
基本信息
Path: /message/conversation
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
limit | 是 | limit | |
msg_id_start | 是 | msg_id_start | |
opposite_id | 是 | opposite_id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object | 非必须 | |||
├─ is_last | boolean | 非必须 | |||
├─ messages | object [] | 非必须 | item 类型: object | ||
├─ attachment | string | 非必须 | |||
├─ config | string | 非必须 | |||
├─ content | string | 非必须 | |||
├─ ctype | string | 非必须 | |||
├─ ext | string | 非必须 | |||
├─ from_xid | object | 非必须 | |||
├─ device_sn | integer | 非必须 | format: int32 | ||
├─ set_device_sn | boolean | 非必须 | |||
├─ set_uid | boolean | 非必须 | |||
├─ uid | integer | 非必须 | format: int64 | ||
├─ msg_id | integer | 非必须 | format: int64 | ||
├─ set_attachment | boolean | 非必须 | |||
├─ set_config | boolean | 非必须 | |||
├─ set_content | boolean | 非必须 | |||
├─ set_ctype | boolean | 非必须 | |||
├─ set_ext | boolean | 非必须 | |||
├─ set_from_xid | boolean | 非必须 | |||
├─ set_msg_id | boolean | 非必须 | |||
├─ set_status | boolean | 非必须 | |||
├─ set_timestamp | boolean | 非必须 | |||
├─ set_to_xid | boolean | 非必须 | |||
├─ status | string | 非必须 | 枚举: UNREAD,DELIVERED,READ | ||
├─ timestamp | integer | 非必须 | format: int64 | ||
├─ to_xid | object | 非必须 | |||
├─ device_sn | integer | 非必须 | format: int32 | ||
├─ set_device_sn | boolean | 非必须 | |||
├─ set_uid | boolean | 非必须 | |||
├─ uid | integer | 非必须 | format: int64 | ||
├─ messages_iterator | object | 非必须 | |||
├─ messages_size | integer | 非必须 | format: int32 | ||
├─ next_msg_id | integer | 非必须 | format: int64 | ||
├─ set_is_last | boolean | 非必须 | |||
├─ set_messages | boolean | 非必须 | |||
├─ set_next_msg_id | boolean | 非必须 | |||
message | string | 非必须 | 错误信息,如果成功,该项为null |
取指定用户的最近会话列表
基本信息
Path: /message/unread
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
access-token | 否 | 令牌 | ||
app_id | 是 | 应用ID | ||
group_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口 | ||
user_id | 否 | 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | integer | 非必须 | 返回码,200是成功 | format: int32 | |
data | object [] | 非必须 | 结果数据 | item 类型: object | |
├─ conversation_id | object | 非必须 | |||
├─ device_sn | integer | 非必须 | format: int32 | ||
├─ set_device_sn | boolean | 非必须 | |||
├─ set_uid | boolean | 非必须 | |||
├─ uid | integer | 非必须 | format: int64 | ||
├─ num | integer | 非必须 | format: int32 | ||
├─ set_conversation_id | boolean | 非必须 | |||
├─ set_num | boolean | 非必须 | |||
message | string | 非必须 | 错误信息,如果成功,该项为null |