You need to enable JavaScript to run this app.
导航
创建会话 CreateConversation
最近更新时间:2024.04.01 14:10:02首次发布时间:2023.04.24 11:11:46

你可以使用此接口创建会话。

使用说明

接口行为

你可以调用CreateConversation接口,指定你所属的AppId、会话成员 ID 和会话详细信息进行创建会话。

请谨慎传入IdempotentId幂等Id,单聊如果不传幂等Id,IM服务端内部会根据双方的UserId拼接做为幂等Id,最终的效果就是双方只能创建一个单聊,如果创建时指定了幂等Id,IM服务端会优先以传入的为准,如果创建单聊时传入的幂等Id跟之前的单聊不一致,可能会出现双方创建多个单聊的情况。群聊如果不传幂等Id,IM服务端会使用一个不重复随机数作为幂等Id。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI

注意事项

QPS 不得超过 50。

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=CreateConversation&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringCreateConversation接口名称。当前 API 的名称为 CreateConversation
VersionString2020-12-01接口版本。当前 API 的版本为 2020-12-01

Body

参数类型是否必选示例值描述
AppIdInteger000000应用的唯一标志
InboxTypeInteger0信箱,用做逻辑隔离 默认值为 0
ConversationCoreInfoObject of ConversationCoreInfo-会话详细信息
OwnerUserIdLong10001会话成员 UserId
OtherUserIdLong10002另一个成员的 UserId, 创建单聊必填

IdempotentId

String

"unique-key"

幂等id,如果创建时指定了此字段,并且数据库中存在此 id 对应的会话,则不会重复创建,并且接口返回的Exist字段为true
请谨慎传入IdempotentId幂等Id,尤其是单聊场景,单聊如果不传幂等Id,IM服务端内部会根据双方的UserId拼接做为幂等Id,最终的效果就是双方只能创建一个单聊,如果创建时指定了幂等Id,IM服务端会优先以传入的为准,如果相同的双方创建单聊时传入的幂等Id跟之前的单聊不一致,可能会出现双方创建多个单聊的情况。群聊如果不传幂等Id,IM服务端会使用一个不重复随机数作为幂等Id。

ConversationCoreInfo

参数类型是否必选示例值描述
NameStringconversation会话名称
AvatarUrlStringhttp://xxx.com会话头像 url
DescriptionStringYour_Description会话描述
NoticeStringYour_Notice会话公告
ExtJSON Map"unique-key"扩展字段

ConversationType

Integer

1

会话类型

  • 1:单聊
  • 2:群聊
  • 100:直播群

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数类型示例值描述
ConversationShortIdLong000001会话id
ConversationIdStringConversationId会话Id,字符串类型,含义跟ConversationShortId一样,用来定位唯一的一个会话,历史原因,目前大部分接口都在使用ConversationShortId,但是仍然有比较比较老的接口会使用到ConversationId,如果目前您接入的功能没有使用到ConversationId直接忽略即可
ExistBooleantrue会话是否存在
ConversationInfoObject of ConversationInfo-会话详细信息

ConversationInfo

参数类型示例值描述
ConversationShortIdLong000001会话 ID
ConversationIdStringConversationId会话Id,字符串类型,含义跟ConversationShortId一样,用来定位唯一的一个会话,历史原因,目前大部分接口都在使用ConversationShortId,但是仍然有比较比较老的接口会使用到ConversationId,如果目前您接入的功能没有使用到ConversationId直接忽略即可
AppIdInteger000000应用的唯一标志
InboxTypeInteger0信箱,用于逻辑隔离
NameStringConversation群名
AvatarUrlStringhttp://xxx.com群头像 url
DescriptionStringYour_Description群描述
OwnerUserIdLong100001群主 UserId
CreatorUserIdLong100001创群人 UserId
NoticeStringYour_Notice群公告

Status

Integer

0

会话状态。

  • 0:正常
  • 1:已解散
ExtJSON Map{"key":"value"}会话的扩展字段。
CreateTimeLong1666598278群聊创建时间戳,单位为秒
ModifyTimeLong1666598278修改时间戳,单位为秒

ConversationType

Integer

1

会话类型。

  • 1:单聊
  • 2:群聊
MemberCountLong2会话成员数
OnlineCountLong2直播群在线人数
OtherUserIdLong10002单聊另一个成员的 UserId

请求示例

POST https://rtc.volcengineapi.com?Action=CreateConversation&Version=2020-12-01
{
    "AppId": 000000,
    "InboxType": 0,
    "ConversationCoreInfo": {
        "Name": "Conversation",
        "AvatarUrl": "http://xxx.xxx",
        "Description": "Your_Description",
        "Notice": "Your_Notice",
        "Ext": {
            "key": "value"
        },
        "ConversationType": 2
    },
    "OwnerUserId": 10001
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "CreateConversation",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "ConversationShortId": 000001,
        "Exist": true,
        "ConversationInfo": {
            "ConversationShortId": 000001,
            "AppId": 000000,
            "InboxType": 0,
            "Name": "Conversation",
            "AvatarUrl": "http://xxx.xxx",
            "Description": "Your_Description",
            "OwnerUserId": 100001,
            "CreatorUserId": 100001,
            "Notice": "Your_Notice",
            "Status": 0,
            "Ext": {
                "key": "value"
            },
            "CreateTime": 1666598278,
            "ModifyTime": 1666598278,
            "ConversationType": 1,
            "MemberCount": 2,
            "OnlineCount": 2,
            "OtherUserId": 10002
        }
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。