產生 WhatsApp 群組邀請連結 - AddChatGroupInviteLink - Message Service ChatApp - 阿里雲 - Chat App Message Service

介面說明

重要透過 API 新增 IM 群組邀請連結功能屬於 Meta 內測功能，請聯絡您的商務經理申請加入白名單。

在呼叫此介面之前，請確保您已有建立成功的 IM 群組。
若您沒有已建立成功的 IM 群組，可透過 AddChatGroup 介面建立 IM 群組。
在呼叫此介面新增 IM 群組邀請連結後，您可以使用此連結邀請成員進入 IM 群組。
進入 IM 群組的方式目前僅支援透過邀請連結的方式進入。
通道類型為 WhatsApp 的群組成員最大數量為 8 人。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cams:AddChatGroupInviteLink

create

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
BusinessNumber	string	是	商家號碼。可透過 ListChatGroup 介面檢視商家號碼。	8613800***
ChannelType	string	否	類型。取值： WHATSAPP。說明目前僅支援 WhatsApp 通道類型訊息。	WHATSAPP
GroupId	string	是	群組 ID。可透過 ListChatGroup 介面檢視群組 ID。	E93kdk****
CustSpaceId	string	是	ISV 子客戶的 SpaceId/執行個體 ID。即通道 ID，在通道管理介面檢視。	cams-x***

返回參數

名稱	類型	描述	樣本值
	object
AccessDeniedDetail	string	存取被拒絕詳細資訊。	None
Message	string	錯誤提示資訊。	None
RequestId	string	請求 ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
InviteLink	string	邀請連結。	https://chat.whatsapp.com/****
Code	string	請求狀態碼。取值： OK：代表請求成功。其他錯誤碼，請參閱錯誤碼列表。	OK
Success	boolean	是否呼叫成功。取值： true：呼叫成功。 false：呼叫失敗。	true

樣本

正常返回樣本

JSON格式

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O\n",
  "InviteLink": "https://chat.whatsapp.com/****",
  "Code": "OK",
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。