跳至主要内容

InvitationLinks

此方法負責產生邀請連結。

原始邀請連結格式，需要依照以下格式進行拼接

https://bcrw.apple.com/urn:biz:\{businessId\}?biz-group-id=\{group\}&biz-intent-id=language:\{language\};source:\{source\};externalId:\{externalId\};tags:\{tags\};gender:\{gender\};appKey:\{appKey\}

實際邀請連結格式。Apple Messages 在呼叫邀請連結時會驗證參數格式。為確保參數能夠正確傳遞，biz-intent-id 參數應透過 ASCII 編碼

https://bcrw.apple.com/urn:biz:\{businessId\}?biz-group-id=\{group\}&biz-intent-id=entryCode%3a&lt;font color="red">abc</font>%3blanguage%3a<font color="red">zh-CN</font>%3bsource%3a<font color="red">WEB</font>%3bexternalId%3a<font color="red">123</font>%3btags%3a<font color="red">1</font>%2c<font color="red">2</font>%3bgender%3a<font color="red">MALE</font>%3bappKey%3a<font color="red">784ygf</font>&body=Hi

連接 biz-intent-id 的格式應遵循以下結構：[code1:value1;code2:value2;code3:value3]，其中代碼和值元件都不能包含冒號（:）字元。如果存在冒號，參數將無法解析。

Parameters/ VariablesDescription
businessId此變數是您企業的唯一識別碼。
biz-group-id此參數用於將使用者分組，以便更輕鬆地進行細分和定向，最多 512 個字元
biz-intent-id此參數包含多條資訊，這些資訊將用於識別使用者互動的情境，由 ASCII 編碼，最多 512 個字元
language訊息的語言（例如，en-US 表示英語），請參考這個區域語言代碼對照表
sourceOne of: INBOUND_MESSAGE,API,CAMPAIGN,FUSION_CONTACTS,EMAIL,WEB,MOBILE,APP
externalId您想要分配給聯絡人的唯一識別碼（可以是您選擇的任何字串），最多 128 個字元
tags與使用者關聯的標籤 ID 的逗號分隔清單，用於分段或分類。
genderOne of: MALE, FEMALE
appKeyKey of the application

📄️ 建立通用邀請連結

此操作會產生一個通用邀請連結，可用於引導使用者進入您的業務頻道。當新使用者點擊該連結並傳送第一則訊息時，將會開啟一段新的對話。對於 Apple Messages 頻道，可以使用入口參數（「intent」、「group」和「body」）來識別使用者意圖、分組以及預填充訊息。對於 Viber 頻道，「intent」對應至 Viber 的 context 參數（使用者傳送第一則訊息時以 tracking_data 形式透過 webhook 傳回），「body」對應至 Viber 的 text 參數（預填充使用者的聊天輸入框）；兩者均會自動進行 URL 百分比編碼（percent-encoding）。當新使用者傳送第一則訊息時，這些參數將在 webhook 請求中傳回。

📄️ 建立唯一的 Apple Messages 邀請連結

此操作用於建立一個唯一的短連結，將 Apple Messages 上的新使用者訂閱與現有聯絡人關聯起來。Apple Messages 不提供電話號碼或 Apple ID 等使用者相關資訊。預設情況下，我們的平台會為每個新使用者訂閱建立一個新的聯絡人/對話。此操作透過建立唯一的邀請連結，協助將新使用者的訂閱連結到現有聯絡人。一旦使用者透過唯一邀請連結啟動對話，我們的平台將識別它並將對話連結到現有聯絡人。如果聯絡人尚未使用，該端點將傳回為該聯絡人最後產生的 URL。