AddChatGroup - 创建IM群

创建IM群。

接口说明

重要

通过 API 创建 IM 群功能属于 Meta 内测功能,请联系您的商务经理申请加白。

  • 您可通过此接口创建 IM 群,暂仅支持 API 方式创建 IM 群。

  • 创建成功后您可通过 AddChatGroupInviteLink 接口添加 IM 群邀请链接邀请成员进入 IM 群。

  • 通道类型为 WhatsApp 的群组成员最大数量为 8 人。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

BusinessNumber

string

手机号码。

8613800***

Description

string

群组描述。

这是一个新创建的群组

Subject

string

群组标题。

测试

CustSpaceId

string

ISV 子客户的 SpaceId/实例 ID。即为通道 ID,在通道管理界面查看。

cams-***

ChannelType

string

通道类型。取值:

  • WHATSAPP

说明

暂仅支持 WhatsApp 通道类型消息。

WHATSAPP

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝详细信息。

None

UniqueCode

string

请求唯一 Code。

8938****

Message

string

错误提示信息。

RequestId

string

请求 ID。

90E63D28-E31D-1EB2-8939-A94866411B2O

Code

string

请求状态码。取值:

OK

Success

boolean

是否调用成功。取值:

  • true:调用成功。

  • false:调用失败。

false

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "UniqueCode": "8938****",
  "Message": "无",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": false
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情