跳到主要内容

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 信息邀请链接

此操作用于创建一个唯一的短链接，将Apple Messages上的新用户订阅与现有联系人关联起来。Apple Messages不提供电话号码或Apple ID等用户相关信息。默认情况下，我们的平台会为每个新用户订阅创建一个新的联系人/对话。此操作通过创建唯一的邀请链接，帮助将新用户的订阅链接到现有联系人。一旦用户通过唯一邀请链接激活对话，我们的平台将识别它并将对话链接到现有联系人。如果联系人尚未使用，该端点将返回为该联系人最后生成的URL。