/survey/v1/{subAccountId}/{surveyId}/single
About SMS Engage
- SMS Engage combines the reach of SMS and the power of interactive web surveys
- Using the API endpoint lets you send SMS containing special links to surveys for any use case:
- Satisfaction feedback (NPS, CSAT, CES…)
- Interactive marketing landing page
- E-commerce confirmations (Order, Delivery, Payment)
- and much more: reach out to learn more!
- SMS Engage surveys are linked to your Wavecell account: each individual survey response can be tracked back to the original SMS or SMS campaigns: get individual response logs and aggregated analytics in your Wavecell Customer Portal
- You can also retrieve the SMS Engage response programmatically using the dedicated webhook
About the API endpoint / method
- Sending a POST request on this endpoint allows to send SMS Engage individually (1 message per request).
- It is ideal when you want to integrate surveys as part of your customer experience and trigger an SMS Engage following an event occurring in your application (eg: NPS survey sent after customer support interaction)
URL
- The Wavecell subaccountid to use is defined in the URL where you send your POST request as shown below:
https://api.wavecell.com/survey/v1/subAccountId/surveyId/single
You must replace {subAccountId}
in the URL above with the subaccountid that you want to use.
Before you start
- You must have your account activated to use SMS Engage and at least one SMS Engage form created for you by Wavecell. SMS Engage forms are created based on your use-cases. Once they are created, Wavecell will provide you a surveyid and url.
- Please note that the variable url is your default SMS Engage link which Wavecell has set up for you (e.g. http://smstoweb.net?sid=1234). The url is shortened once the message has been sent.
- The shortened url is always 21 characters in length.
- If you want to get the data via Webhooks, simply provide us a specific url where we will post the data.
- For more information please contact your account manager or contact the product team.
Authorization
Request Parameters
Request Body
MSISDN (destination mobile phone number). We accept both international and national formats (for national you have to specify country in the dedicated field).
Optional country code of Destination number(ISO 3166-1 alpha-2), if you know it. It will help to convert number from national to international format
Template of message to user. It should have the variable {{url:}} which is the default link set for you by Wavecell
variables or pre-defined fields used inside the templateBody
Source number (SenderId) - “From:” field for the SMS
Client managed id for the message: your own unique reference
Encoding for the text of the message
Date and time when a schedule delivery of the message must happen
Date and time after which a message cannot be sent
Webhook URL where delivery status for the SMS will be posted (Overwrites your default account callback URL).
Responses
OK
Unique message id (guid) generated by Wavecell platform upon message submission
Mobile phone number (MSISDN) to which the SMS was sent
Detected message encoding. Useful when sending initial request with encoding=AUTO
Your custom identifier for the message