post

/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

apiKey - Authorization

Request Parameters

2 Path Parameters
1 Header

Request Body

1 Example
Schema
object
destination
string

MSISDN (destination mobile phone number). We accept both international and national formats (for national you have to specify country in the dedicated field).

1 validation + required
country
string

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

2 validations
templateBody
string

Template of message to user. It should have the variable {{url:}} which is the default link set for you by Wavecell

templateVariables
object

variables or pre-defined fields used inside the templateBody

source
string

Source number (SenderId) - “From:” field for the SMS

1 validation
clientMessageId
string

Client managed id for the message: your own unique reference

1 validation
encoding
string

Encoding for the text of the message

2 validations
scheduled
string

Date and time when a schedule delivery of the message must happen

1 validation
expiry
string

Date and time after which a message cannot be sent

1 validation
dlrCallbackUrl
string

Webhook URL where delivery status for the SMS will be posted (Overwrites your default account callback URL).

1 validation

Responses

OK

1 Example
Schema
object

Response object of sending one SMS

umid
string

Unique message id (guid) generated by Wavecell platform upon message submission

required
destination
string

Mobile phone number (MSISDN) to which the SMS was sent

1 validation + required
status
object
2 validations + required
encoding
string

Detected message encoding. Useful when sending initial request with encoding=AUTO

1 validation + required
clientMessageId
string

Your custom identifier for the message

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
subAccountId
surveyId
$$.env
Authorization
subAccountId