> For the complete documentation index, see [llms.txt](https://docs.ngsurvey.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ngsurvey.com/form-management/campaigns/campaign/phone-sms-distribution/whatsapp-distribution/untitled.md).

# WhatsApp Invitations

## 💬 What are WhatsApp invitation ?

WhatsApp invitations allow you to send out a message to any WhatsApp enabled number with an invitation link to your survey along a unique code to take the survey. Respondents will be able to click on the invitation link to open the browser of their mobile device to take the survey.

## 📝 Approved Message formatting

Twilio / WhatsApp only allows to send out approved messages, as such you will first need need to register your invitation message at Twilio's website. If you would link  to include the invitation link in your message you can customize the following default invitation message &#x20;

WhatsApp approved message with one parameter that will be replaced by the invitation link example.

> Hi,
>
> we would like to know your opinion about our product and services, you may share it with us using following link {1} or if you dont want to receive any further messages please follow this link {2}

ngSurvey invitation message that will send out the invitation link.

> Hi,\
> \
> we would like to know your opinion about our product and services, you may share it with us using following link localhost:8081/s/\[--surveyid-]?uid=\[--invitationid-]\&ngs\_cid=\[--campaignid-] or if you dont want to receive any further messages please follow this link localhost:8081/s/\[--surveyid-]/unsub/\[--unsubscribeid-]?bltype=1

{% hint style="danger" %}
The WhatsApp features requires to have a [Twilio.com account](/installation-setup/installation/whatsapp-messenging/twilio-whatsapp.md) with a Facebook Business Manager account and that your Twilio account is [setup](/installation-setup/system-settings.md) in your ngSurvey installation.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ngsurvey.com/form-management/campaigns/campaign/phone-sms-distribution/whatsapp-distribution/untitled.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
