创建或获取会话 - 齐成云·IM消息服务

创建新会话或获取已存在的会话，支持多种会话类型和来源类型

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer QC2b8fd0ca342c72f857f5f96

Appid

string

可选

默认值:

1001

ClientId

string

可选

默认值:

131231231223

TimeStamp

string

可选

默认值:

Client-Type

string

可选

默认值:

EnterpriseCenterWEB

Body 参数application/json

peerId

string

对方用户ID

必需

>= 1 字符<= 50 字符

示例值:

user_123456

chatsType

enum<string>

会话类型

必需

枚举值:

friendgroupservicetemporarysystemcustomer_service

示例值:

friend

sourceType

enum<string>

来源类型

必需

枚举值:

internalmeituanelemedouyinxiaohongshuwechatalipaytaobaojdother

示例值:

internal

chatsName

string

会话名称

必需

>= 1 字符<= 100 字符

示例值:

与张三的聊天

chatsIcon

string

会话图标URL

必需

>= 1 字符<= 500 字符

示例值:

https://example.com/avatar.jpg

sourceAppId

string

可选

来源应用ID（可选）

<= 100 字符

示例值:

app_12345

webHookUrl

string

可选

Webhook URL（可选）

<= 500 字符

示例值:

https://example.com/webhook

badgeIconUrl

string

可选

徽章图标URL（可选）

<= 500 字符

示例值:

https://example.com/badge.png

示例

{
    "peerId": "user_123456",
    "chatsType": "friend",
    "sourceType": "internal",
    "chatsName": "与张三的聊天",
    "chatsIcon": "https://example.com/avatar.jpg",
    "sourceAppId": "app_12345",
    "webHookUrl": "https://example.com/webhook",
    "badgeIconUrl": "https://example.com/badge.png"
}

返回响应

🟢200成功

application/json

会话创建或获取成功

Body

success

boolean

操作是否成功

必需

message

string

响应消息

必需

code

integer

状态码

可选

data

object

ChatsInfo

可选

chats_id

integer

会话ID

可选

user_id

string

用户ID

可选

peer_id

string

对方ID

可选

chats_key

string

会话唯一标识

可选

chats_type

enum<string>

会话类型

可选

枚举值:

friendgroupservicetemporarysystemcustomer_service

source_type

enum<string>

来源类型

可选

枚举值:

internalmeituanelemedouyinxiaohongshuwechatalipaytaobaojdother

chats_name

string

会话名称

可选

chats_icon

string

会话图标

可选

unread_count

integer

未读消息数

可选

last_message_content

string

最后消息内容

可选

last_message_type

string

最后消息类型

可选

last_send_time

string <date-time>

最后发送时间

可选

示例

{
    "success": true,
    "message": "string",
    "code": 0,
    "data": {
        "chats_id": 0,
        "user_id": "string",
        "peer_id": "string",
        "chats_key": "string",
        "chats_type": "friend",
        "source_type": "internal",
        "chats_name": "string",
        "chats_icon": "string",
        "unread_count": 0,
        "last_message_content": "string",
        "last_message_type": "string",
        "last_send_time": "2019-08-24T14:15:22Z"
    }
}

🟠400请求有误

🟠401没有权限

🔴500服务器错误