即时通讯

  • 即时通讯 > API 文档 > 服务端API > 消息处理

    消息处理

    最近更新时间:2021-06-29 09:49:58

    消息处理

    删除用户的指定会话

    基本信息

    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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    attachmentstring非必须
    configstring非必须
    contentstring非必须
    content_typeinteger必须消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7;

    最大值: 7

    最小值: 0

    format: int32

    extstring非必须
    from_user_idinteger非必须发送者的用户ID

    format: int64

    targetsinteger []必须接收用户ID或群ID

    item 类型: integer

    ├─ 非必须
    transaction_idinteger非必须交易ID,用于消息去重

    format: int64

    typeinteger必须目标类型,1 - 普通用户,2 - 群组

    最大值: 2

    最小值: 1

    format: int32

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    attachmentstring非必须
    configstring非必须
    contentstring非必须
    content_typeinteger必须消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7;

    最大值: 7

    最小值: 0

    format: int32

    extstring非必须
    from_user_idinteger非必须发送者的用户ID

    format: int64

    targetsinteger []必须接收用户ID或群ID

    item 类型: integer

    ├─ 非必须
    transaction_idinteger非必须交易ID,用于消息去重

    format: int64

    typeinteger必须目标类型,1 - 普通用户,2 - 群组

    最大值: 2

    最小值: 1

    format: int32

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    attachmentstring非必须
    configstring非必须
    contentstring非必须
    content_typeinteger必须消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7;

    最大值: 7

    最小值: 0

    format: int32

    extstring非必须
    from_user_idinteger非必须发送者的用户ID

    format: int64

    targetsinteger []必须接收用户ID或群ID

    item 类型: integer

    ├─ 非必须
    transaction_idinteger非必须交易ID,用于消息去重

    format: int64

    typeinteger必须目标类型,1 - 普通用户,2 - 群组

    最大值: 2

    最小值: 1

    format: int32

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    名称类型是否必须默认值备注其他信息
    attachmentstring非必须
    configstring非必须
    contentstring非必须
    content_typeinteger必须消息类型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7;

    最大值: 7

    最小值: 0

    format: int32

    extstring非必须
    from_user_idinteger非必须发送者的用户ID

    format: int64

    targetsinteger []必须接收用户ID或群ID

    item 类型: integer

    ├─ 非必须
    transaction_idinteger非必须交易ID,用于消息去重

    format: int64

    typeinteger必须目标类型,1 - 普通用户,2 - 群组

    最大值: 2

    最小值: 1

    format: int32

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    databoolean非必须结果数据
    messagestring非必须错误信息,如果成功,该项为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

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须
    ├─ is_lastboolean非必须
    ├─ messagesobject []非必须

    item 类型: object

    ├─ attachmentstring非必须
    ├─ configstring非必须
    ├─ contentstring非必须
    ├─ ctypestring非必须
    ├─ extstring非必须
    ├─ from_xidobject非必须
    ├─ device_sninteger非必须

    format: int32

    ├─ set_device_snboolean非必须
    ├─ set_uidboolean非必须
    ├─ uidinteger非必须

    format: int64

    ├─ msg_idinteger非必须

    format: int64

    ├─ set_attachmentboolean非必须
    ├─ set_configboolean非必须
    ├─ set_contentboolean非必须
    ├─ set_ctypeboolean非必须
    ├─ set_extboolean非必须
    ├─ set_from_xidboolean非必须
    ├─ set_msg_idboolean非必须
    ├─ set_statusboolean非必须
    ├─ set_timestampboolean非必须
    ├─ set_to_xidboolean非必须
    ├─ statusstring非必须

    枚举: UNREAD,DELIVERED,READ

    ├─ timestampinteger非必须

    format: int64

    ├─ to_xidobject非必须
    ├─ device_sninteger非必须

    format: int32

    ├─ set_device_snboolean非必须
    ├─ set_uidboolean非必须
    ├─ uidinteger非必须

    format: int64

    ├─ messages_iteratorobject非必须
    ├─ messages_sizeinteger非必须

    format: int32

    ├─ next_msg_idinteger非必须

    format: int64

    ├─ set_is_lastboolean非必须
    ├─ set_messagesboolean非必须
    ├─ set_next_msg_idboolean非必须
    messagestring非必须错误信息,如果成功,该项为null

    取指定用户的最近会话列表

    基本信息

    Path: /message/unread

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject []非必须结果数据

    item 类型: object

    ├─ conversation_idobject非必须
    ├─ device_sninteger非必须

    format: int32

    ├─ set_device_snboolean非必须
    ├─ set_uidboolean非必须
    ├─ uidinteger非必须

    format: int64

    ├─ numinteger非必须

    format: int32

    ├─ set_conversation_idboolean非必须
    ├─ set_numboolean非必须
    messagestring非必须错误信息,如果成功,该项为null
    以上内容是否对您有帮助?
  • Qvm free helper
    Close