本文介绍单聊会话创建回调(Callback.CreateSingleChat)的功能说明、请求参数、返回数据和示例。
功能说明
客户端发起的单聊会话创建调用时,AIMServer会回调AppServer,会话ID在回调中生成。
说明 自定义会话ID时必须以
$3$
开头。
如果使用标准单聊会话,可以选择不回调;如果没有使用标准单聊会话,且又没有开启回调,会报错。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
creatorAppUid | String | 是 | 1001 | 操作用户ID。 |
appCid | String | 否 | $3$1001:1002 | 自定义单聊会话ID。 |
appUids | List<String> | 是 | ["1002", "1001"] | 单聊会话中的两个账号的ID信息。 |
extensions | Map<String, String> | 否 | {"ext_k1":"ext_v1"} | 扩展信息。 |
bizCtx | Map<String, String> | 否 | {"biz_k1":"biz_v1"} | AppClient传递给AppServer信息,PaaS平台不做处理。 |
paasCtx | Map<String, String> | 否 | {"paas_k1":"paas_v1"} | PaaS平台信息。包括发起端的信息,目前包括以下key:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | object | 返回结果。 | |
allow | Boolean | true | 是否允许创建。取值:
|
code | String | 0xx | 不允许创建时的返回码。
allow为true时会被忽略,为false时必填。 |
reason | String | security filter | 错误原因。关于code的解释。 |
appCid | String | $3$1001:1002 | 创建的单聊会话ID。 |
extensions | Map<String, String> | {"ext_k1":"ext_v1"} | 修改后的消息扩展信息,覆盖语义。 |
userConversations | Map<String, UserConversation> | 会话视图信息,一般只填写创建者的会话视图信息。
|
|
String | 1001 | key:appUid。用户ID。 | |
UserConversation | value:UserConversation。会话视图信息。 | ||
top | Boolean | false | 是否置顶。默认值为false,一般不填。 |
mute | Boolean | false | 是否免打扰。默认值为false,一般不填。 |
redPoint | Integer | 0 | 会话未读红点数。默认值为0,一般不填。 |
visible | Boolean | false | 是否可见。默认值为false,一般不填。 |
userExtensions | Map<String, String> | {"k1": "v1", "k2": "v2"} | 用户扩展信息。 |
请求示例
{
"creatorAppUid": "1001",
"appCid": "$3$1001:1002",
"appUids": ["1002", "1001"],
"extensions": {
"key": "value"
},
"bizCtx": {
"key": "value"
},
"paasCtx": {
"key": "value"
}
}
返回示例
{
"data": {
"result": {
"allow": true,
"code": "",
"reason": ""
},
"appCid": "$3$1001:1002",
"extensions": {
"k1": "k1"
},
"userConversations": {
"1001": {
"userExtensions": {
"k1": "v1",
"k2": "v2"
}
}
]
}
}