Interakt

Usage Instructions

Use Interakt, the WhatsApp Business platform for Indian businesses, to send approved WhatsApp templates with header, body, and button values, reply with free-form text or media, create and update contacts with traits and tags, record events that start Interakt campaigns, and list your templates. WhatsApp allows free-form messages only within 24 hours of the customer’s last message. Outside that window, or to start a conversation, send an approved template. Interakt can also trigger workflows on incoming messages and on template status (sent, delivered, read, failed, clicked).

Actions

Interakt List Templates

List the WhatsApp templates in your Interakt account with their code name, language, category, approval status, and text. Use it to find the template name and variables before sending a template.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Interakt API key (Interakt → Settings → Developer Settings → Secret Key)
`templateName`	string	No	Only return the template with this code name
`approvalStatus`	string	No	Only return templates with this approval status, e.g. APPROVED
`language`	string	No	Only return templates in this language code, e.g. en
`offset`	number	No	Number of templates to skip, for the next page when hasNext is true

Output

Parameter	Type	Description
`templates`	array	Templates in the account
↳ `id`	string	Interakt template ID
↳ `name`	string	Code name used to send the template
↳ `displayName`	string	Display name in Interakt
↳ `language`	string	Language code
↳ `category`	string	Template category, e.g. UTILITY or MARKETING
↳ `approvalStatus`	string	WhatsApp approval status, e.g. APPROVED
↳ `headerFormat`	string	Header format, if any
↳ `header`	string	Header text, if any
↳ `body`	string	Body text with {{1}}-style variables
↳ `footer`	string	Footer text, if any
↳ `buttons`	string	Buttons as a JSON string
↳ `variablePresent`	string	Whether the template has variables
↳ `waTemplateId`	string	WhatsApp template ID
↳ `createdAt`	string	When the template was created (UTC)
`count`	number	Number of matching templates
`hasNext`	boolean	Whether more templates are available

Interakt Send Session Message

Send a free-form WhatsApp reply (text, image, document, audio, or video) through Interakt. WhatsApp only allows free-form (session) messages within 24 hours of the customer’s last message to your number. Outside that window, or to start a conversation, you must send a pre-approved template. Interakt rejects a session message when the customer has not messaged in the last 24 hours.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Interakt API key (Interakt → Settings → Developer Settings → Secret Key)
`phoneNumber`	string	No	Customer phone number without the country code or a leading 0 (e.g. 9876543210). Use with countryCode
`countryCode`	string	No	Country code of phoneNumber, with a plus sign (e.g. +91). Defaults to +91
`fullPhoneNumber`	string	No	Full phone number with the country code and no plus sign (e.g. 919876543210). Use instead of phoneNumber and countryCode
`messageType`	string	Yes	Message type: Text, Image, Document, Audio, or Video
`message`	string	No	Message text. Required for Text; the caption for media messages
`mediaUrl`	string	No	Public URL of the media file. Required for Image, Document, Audio, and Video
`fileName`	string	No	File name shown for a media message, e.g. invoice.pdf
`callbackData`	string	No	Up to 512 characters returned in this message’s webhooks

Output

Parameter	Type	Description
`messageId`	string	Interakt message ID; delivery-status webhooks refer to it
`message`	string	Confirmation message from Interakt

Interakt Send Template

Send an approved WhatsApp template message through Interakt, filling its header, body, and button variables. WhatsApp only allows free-form (session) messages within 24 hours of the customer’s last message to your number. Outside that window, or to start a conversation, you must send a pre-approved template. Returns the message ID that delivery-status webhooks refer to.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Interakt API key (Interakt → Settings → Developer Settings → Secret Key)
`phoneNumber`	string	No	Customer phone number without the country code or a leading 0 (e.g. 9876543210). Use with countryCode
`countryCode`	string	No	Country code of phoneNumber, with a plus sign (e.g. +91). Defaults to +91
`fullPhoneNumber`	string	No	Full phone number with the country code and no plus sign (e.g. 919876543210). Use instead of phoneNumber and countryCode
`templateName`	string	Yes	Code name of an approved template in Interakt (shown by the info icon on the Templates page), e.g. order_confirmation
`languageCode`	string	Yes	Language the template was created in, e.g. en, en_US, or hi
`headerValues`	array	No	Header variable values in order. For an image, video, or document header, a single public media URL
`bodyValues`	array	No	Body variable values in order: the first fills {{1}}, the second {{2}}, ...
`buttonValues`	json	No	Dynamic URL button values keyed by button index starting at 0, e.g. {"1": ["ORDER123"]} fills {{1}} in the URL of the second button
`buttonPayload`	json	No	Quick reply payloads keyed by button index starting at 0, e.g. {"0": ["yes"], "1": ["no"]}. Strings of at most 128 characters, up to 3 buttons
`fileName`	string	No	File name shown for a document header, e.g. invoice.pdf
`callbackData`	string	No	Up to 512 characters returned in this message’s webhooks, e.g. your order or lead ID
`campaignId`	string	No	Interakt API campaign ID, so the send is counted in that campaign’s analytics

Output

Parameter	Type	Description
`messageId`	string	Interakt message ID; delivery-status webhooks refer to it
`message`	string	Confirmation message from Interakt

Interakt Track Event

Record an event (e.g. "Order Placed", "Cart Abandoned") with properties on a contact’s Interakt timeline. An Interakt ongoing campaign that uses the event as its trigger then sends its approved template automatically.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Interakt API key (Interakt → Settings → Developer Settings → Secret Key)
`phoneNumber`	string	No	Customer phone number without the country code or a leading 0 (e.g. 9876543210). Use with countryCode
`countryCode`	string	No	Country code of phoneNumber, with a plus sign (e.g. +91). Defaults to +91
`fullPhoneNumber`	string	No	Full phone number with the country code and no plus sign (e.g. 919876543210). Use instead of phoneNumber and countryCode
`userId`	string	No	Your own ID for the contact. Either userId or a phone number is required
`eventName`	string	Yes	Name of the event, e.g. Order Placed
`traits`	json	No	Flat JSON object of event properties, e.g. {"orderNumber": "CUS001", "orderValue": "50.00"}

Output

Parameter	Type	Description
`id`	string	ID of the recorded event
`message`	string	Confirmation message from Interakt

Interakt Track User

Create or update a WhatsApp contact in Interakt with traits (name, email, custom attributes) and tags. A new value for an existing trait replaces the old one; tags can only be added, not removed.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Interakt API key (Interakt → Settings → Developer Settings → Secret Key)
`phoneNumber`	string	No	Customer phone number without the country code or a leading 0 (e.g. 9876543210). Use with countryCode
`countryCode`	string	No	Country code of phoneNumber, with a plus sign (e.g. +91). Defaults to +91
`fullPhoneNumber`	string	No	Full phone number with the country code and no plus sign (e.g. 919876543210). Use instead of phoneNumber and countryCode
`userId`	string	No	Your own ID for the contact. Either userId or a phone number is required; a new userId must not belong to another contact
`traits`	json	No	Flat JSON object of contact attributes, e.g. {"name": "Asha", "email": "asha@example.com", "city": "Pune"}. Values must not contain newlines, tabs, or runs of spaces
`tags`	array	No	Tags to add to the contact, e.g. ["new customer", "potential lead"]

Output

Parameter	Type	Description
`message`	string	Confirmation message from Interakt

Interakt

On this page