¶ Create a mailing list
-
Go to the Notifications section of the personal account platform.
-
Click Distribution Creation or
on the Send Messages tab in the upper left corner. The Distribution Creation window will open. -
On the Main tab, do the following:
3.1. Enter any name for the new mailing in the Name field.
3.2 Click Download Distribution Template and select one of the ready-made templates with the specified newsletter parameters:
- Sms Messages - template for SMS messages;
- Advertising Messages - template for advertising messages that can be sent within an active session, but do not affect the dialog;
- Start Chat Sessions - a template for starting a chat session in messengers;
- Launch Chat Session in WhatsApp - template for starting a chat session in WhatsApp;
- Generic (API format) - template with a full list of parameters in API format.
Or create your own template with the required parameters. To do this, download the Full list of params file and leave only the columns you need in it, and delete the rest.
See full description of all template parameters
| Field name | Required | Description |
|---|---|---|
| callback url | No | URL to which the request will be sent. Arbitrary format. Limit — 4000 bytes. |
| attachments | No | Message attachments such as images, audio, or documents. Max 10 per message. Format: <type><[-]owner_id>_<media_id>. |
| external id | No | ID of the recipient in an external system. Arbitrary format, up to 10240 bytes. |
| start time | Yes | Time when the mailing starts. Format: HH-MM-SS. |
| required | No | Forces sending via the selected channel, even if sent successfully via another. Values: true, false. |
| callback data | No | Custom data for webhook requests. JSON array. Limit — 10240 bytes. |
| start date | Yes | Mailing start date. Format: YY-MM-DD. |
| validity period | Yes | Message delivery lifetime in minutes (1–2880). If not delivered in time, status becomes Expired. |
| allowed time ranges | Yes | Time window for sending messages. Format: JSON string: {"09:30:00", "12:00:00"}. |
| bot id | Yes | Bot ID, displayed in the Bot Scenarios section of the dashboard. |
| group id | No | Optional ID to group messages. |
| bulk id | No | Global identifier for the message. |
| flow id | No | Message group ID for Viber. Can be manually set or auto-generated. |
| client id | No | Client's platform ID. |
| messenger user id | Yes | Recipient's phone number for messenger campaigns. Format: XXXXXXXXXXX. |
| push registration id | No | Unique device identifier for push notifications. |
| chat id | Yes | Chat ID from the Text Bots → Settings section. |
| chat session id | No | ID of an existing chat session. See Chat dialogues. |
| template id | Yes | Notification template ID. See Notifications → Message Templates. |
| from | Yes | Registered sender name shown in the From field. |
| chat session name | Yes | Operator chat session name. Appears in the monthly chat service report. |
| use short links | No | Converts all URLs in the message to short links. Values: true, false. |
| channel | Yes | Message delivery channel. One of: sms, push, viber, whatsapp, chat. |
| channels | No | Multiple delivery channels. JSON format. Only use if advised by TWIN support. |
| send at | Yes | Message sending start time. Format: various, including YY-MM-DD HH:MM:SS. |
| message category | No | Type of message in a marketing campaign. Used for delayed messages. |
| button | No | Button data for chats. JSON format: {"text": "...", "payload": "...", "url": "..."}. |
| error codes | No | Array of error codes in JSON: ["code1", "code2"]. |
| count | No | Number of messages per request. Integer from 1 to 1000. |
| phone number | Yes | Recipient's phone number. Format: XXXXXXXXXXX. |
| chat operator | Yes | Name shown in the From field. |
| main chat id | Yes | Main chat ID, displayed in Text Bots → Settings. |
| display name | No | Displayed sender name. |
| password | Yes | API password. |
| payment data | No | Payment-related data in JSON: {"card_number": "...", "transaction_id": "..."}. |
| platform | Yes | Platform name. Options: iOS, Android, Web. |
| priority | No | Message priority: high, normal, low. |
| send order | Yes | Sending order: sequential or parallel. |
| send rules | No | Sending rules in JSON: {"rule1": "...", "rule2": "..."}. |
| message preview | No | Preview of the message in JSON: {"text": "...", "image_url": "..."}. |
| prefix | No | Phone number prefix, e.g., +1. |
| notes | No | Any additional information. |
| force send | No | Forces message to be sent. Values: true, false. |
| send mode | No | Message send mode: auto, manual. |
| secret key | Yes | API secret key. |
| message content | Yes | Message body text. String format. |
| send status | Yes | Sending status: sent, failed, pending. |
| data structure | No | Message structure in JSON: {"field1": "...", "field2": "..."}. |
| timeout | Yes | Timeout in milliseconds (1000–60000). |
| message type | Yes | Message type: text, image, video, audio, document. |
| recipient type | Yes | Recipient type: individual or group. |
| unique message id | Yes | Unique ID. Arbitrary format, max 10240 bytes. |
| filters | No | Filters in JSON: {"filter1": "...", "filter2": "..."}. |
| language | No | Template language. Example: ru, en. |
| continue last or start new session | Yes | Chat session logic. true — continue if exists; false — always start new. |
| template name | Yes | System template name used for WhatsApp, Chat. |
| from name | Yes | Sender name displayed in WhatsApp. |
| variables | No | List of message variables in JSON: {"var1": "...", "var2": "..."}. |
| template data | No | WhatsApp-specific variables in JSON. |
| destinations | No | Recipient object in JSON. |
| provider | Yes | Do not use unless instructed by TWIN developers. |
| templatenamespace | Yes | WhatsApp Business API namespace. |
| button url | Yes | Viber share button URL. Example: viber://forward?text=.... |
| media url | No | URL to a media file for WhatsApp. |
| button text | No | Button label in WhatsApp. Max 20 characters. |
| text | No | Message body. No character limit. May be split in SMS. |
| phone | Yes | Target phone number. Format: XXXXXXXXXXX. |
| messenger type | Yes | Messenger channel. Options: whatsapp, viber, facebook, telegram, slack, imessage. |
3.3 Fill in the downloaded file.
3.4 Upload it to the mailing list. To do this, click the Select File button and select or drag the completed file into the upload area.
- (Optional) Click the Schedule tab and select the desired sending period. Once the mailing is started, the system will send messages according to the specified time interval.
By default, messages will be sent between 9:00 and 20:00 local time of the subscriber.
- (Optional) Set an additional time interval for sending the newsletter by clicking on
.
Do not allow time intervals to overlap.
- Press Save. The new mailing will appear in the list.
¶ Edit a mailing list
- Go to the Notifications section of the personal account platform. The page with the list of previously created newsletters will open.
- Hover your cursor over the required newsletter and click on
in the newsletter line on the right. This will open the Edit Distribution window. - Make the necessary changes. The steps to edit the mailing list are similar to those described above in Create a mailing list.
- Click Save. The changes you have made will be saved.
¶ Deleting a mailing list
- Go to the Notifications section of the personal cabinet platform. The page with the list of previously created newsletters will open.
- Hover over the desired mailing list and click on
. - Click Delete.
- Confirm the deletion by clicking Delete. The selected mailing will be deleted.
¶ Cancel sending a message
Cancel sending is available for messages in PAUSED, CREATED, DELAYED statuses.
- Go to the Notifications section of the personal account platform.
- Open the Delivery reports tab.
- Hover over the desired newsletter and click on .
- Click Cancel sending. Sending of the selected message will be canceled.