Skip to main content

InvitationLinks

This method is responsible for generating invitation links.

The original invitation link format, need to follow the following format splicing

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\}

The actual invitation link format. Apple Messages will verify the parameter format when calling the invitation link. In order to ensure that the parameters can be passed correctly, the biz-intent-id parameter should be encoded by 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

The format for concatenating biz-intent-id should follow the structure: [code1:value1;code2:value2;code3:value3], where both the code and value components must not contain the colon (:) character. If a colon is present, the parameter will fail to parse.

Parameters/ VariablesDescription
businessIdThis variable is the unique identifier for your business.
biz-group-idThis parameter is used to group users together for easier segmentation and targeting, Maximum 512 characters
biz-intent-idThis parameter includes multiple pieces of information that will be used to identify the context of the user interaction, encoded by ASCII, Maximum 512 characters
languageThe language of the message (e.g., en-US for English), please refer to this regional language code comparison table
sourceOne of: INBOUND_MESSAGE,API,CAMPAIGN,FUSION_CONTACTS,EMAIL,WEB,MOBILE,APP
externalIdA unique identifier you want to assign to the contact (can be any string of your choice), Maximum 128 characters
tagsA comma-separated list of the ID if tags associated with the user for segmentation or categorization purposes.
genderOne of: MALE, FEMALE
appKeyKey of the application

📄️ Create a general invitation link

This operation generates a general invitation link that can be used to direct people to your business channel. When a new user clicks the link and sends a first message, a new conversation will be initiated. For Apple Messages, entry point parameters ('intent', 'group', and 'body') can be used to identify the user intention, group, and pre-fill a message. For Viber, 'intent' maps to the Viber context parameter (reflected back as tracking_data in the webhook) and 'body' maps to the Viber text parameter (pre-fills the user's chat input box with decoded plain text); both are URL percent-encoded automatically. These parameters will be returned in the webhook request when the new user sends the first message.

📄️ Create an unique Apple Messages invitation link

This operation is used to create a unique short link for linking a new user subscription on Apple Messages to an existing contact. Apple Messages doesn't provide user-related information like phone numbers or Apple IDs. By default, our platform creates a new contact/conversation for each new user subscription. This operation helps link a new user's subscription to an existing contact by creating a unique invitation link. Once the user activates a conversation through the unique invitation link, our platform will identify it and link the conversation to the existing contact. The endpoint will return the last generated URL for the contact if it has not yet been used by the contact.