更新会话分组 - 即时通信

请求参数

Path 参数

group_id

integer

会话分组 ID。

必需

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

account_id

string

云信账号 ID。

必需

云信账号 ID。

name

string

更新后的会话分组名称。

可选

更新后的会话分组名称。

server_extension

string

更新后的会话分组扩展字段。

可选

更新后的会话分组扩展字段。

conversations

object

会话列表。

可选

会话列表。

type

integer

操作类型。

必需

操作类型。1：在会话分组中添加会话；2：在会话分组中删除会话。

conversation_ids

array[string]

会话 ID 列表。

必需

会话 ID 列表。最多操作 100 个会话。

示例

{
  "account_id": "string",
  "name": "string",
  "server_extension": "string",
  "conversations": {
    "type": 0,
    "conversation_ids": [
      "string"
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/conversation_groups/' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

conversation_group

object

会话分组。

可选

会话分组。

success_list

array[string]

加入会话分组成功的会话 ID 列表。

可选

加入会话分组成功的会话 ID 列表。

failed_list

array [object {3}]

加入会话分组失败的会话 ID 列表。

可选

加入会话分组失败的会话 ID 列表。

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "conversation_group": {
      "name": "string",
      "group_id": 0,
      "server_extension": "string",
      "create_time": 0,
      "update_time": 0
    },
    "success_list": [
      "string"
    ],
    "failed_list": [
      {
        "conversation_id": "string",
        "error_code": 0,
        "error_msg": "string"
      }
    ]
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误