メインコンテンツまでスキップ

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パラメータ（ユーザーが最初のメッセージを送信するとWebhookのtracking_dataとして返されます）に、「body」はViberのtextパラメータ（ユーザーのチャット入力欄を事前入力します）にそれぞれマッピングされ、どちらも自動的にURLパーセントエンコードされます。これらのパラメータは、新しいユーザーが最初のメッセージを送信したときにWebhookリクエストで返されます。

📄️ ユニークなApple Messagesの招待リンクを作成する

この操作は、Apple Messagesでの新しいユーザーサブスクリプションを既存の連絡先にリンクするための一意の短いリンクを作成するために使用されます。Apple Messagesは電話番号やApple IDなどのユーザー関連情報を提供しません。デフォルトでは、当プラットフォームは新しいユーザーサブスクリプションごとに新しい連絡先/会話を作成します。この操作は、一意の招待リンクを作成することで、新しいユーザーのサブスクリプションを既存の連絡先にリンクするのに役立ちます。ユーザーが一意の招待リンクを通じて会話を開始すると、当プラットフォームはそれを識別し、会話を既存の連絡先にリンクします。このエンドポイントは、連絡先がまだ使用していない場合、その連絡先に対して最後に生成されたURLを返します。