Sending Surveys via SMS Integration

The following steps should be followed for sending surveys via SMS:

• Configuring SMS Servis Provider: You can make the configuration using interactive video.

• Defining the SMS channel, connecting it to the relevant flow, and selecting the service provider to be used.
• In order to send SMS via the SMS channel, the link shortening service must be active. The Pisano service is active in the cloud. For on-premises usage, it is expected that the customer's link shortening service is configured or the Pisano service is used
• Triggering the SMS flow/survey
  
  • Manual triggering by uploading a CSV file: This method is preferred for bulk survey sending. It is used when survey sending is not frequent on a daily basis. Since surveys will be triggered manually, preparation by the business unit is required.
  • Triggering SMs surveys via Workflow:  This method is preferred if bulk survey sending is desired to be done automatically at scheduled times.
  • Triggering the survey using an API (SMS Sharing) (on this page): This method is preferred for automatically triggering transaction-based surveys. Surveys can be sent immediately after the customer completes a transaction. The system sending the request decides when the API will be triggered. Once the API is triggered, SMS sending is facilitated.

Triggering the Survey via API (SMS Sharing)

Endpoint Details

POST  https://<pisanoURL>/v1/sms_campaigns/:campaign_id/sms_sharings/

*** pisanoURL information will be shared with you by Pisano.

*** For on-premises customers, the PisanoURL information should be replaced by the system administrator, in the API configmap (ENV) within the api_host variable

Parameters

Headers (HTTP Header)

Sample cURL Request

curl --location --request POST 'https://<pisanoEnvironment>/v1/sms_campaigns/<campaignID>/sms_sharings' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_numbers": [
        "<phone>"
    ],
    "custom_attributes": {
        "<phone>": {
            "name": "<name>",
            "external_id": "<external_id>",
            "email": "<email>"
        }
    },
    "built_in_responses": {
        "<phone>": {
            "customerDetailedInformation1": "<customerDetailedInformation1>",
            "customerDetailedInformation2": "<customerDetailedInformation2>",
            "customerDetailedInformation3": "<customerDetailedInformation3>"
        }
    }
}'

#   20 requests in 5 seconds

#   40 requests in 25 seconds

#   80 requests in 125 seconds (~2 min)

#   160 requests in 625 seconds (~10 min)

It is recommended as a best practice to trigger up to a maximum of 5000 customers in a single request.

In on-premise installations, Email & SMS & Push notification & Link throttle limits can be increased or completely removed. Throttle rules can be configured based on IP in on-premise installations.

Obtaining API ID (campaign_id)

• Go to Channels > SMS Channels > Add to create a new SMS channel.  Click here for more information about SMS channel creation.

• Click on "Edit Campaign".
  
  
• The API ID that determines which campaign to send is obtained from this screen ( in API usage ). Sample campaign ID: ae51458c-9e82-417f-8f1d-e074891ea5c1
• The link generated for the survey is automatically added to the end of the text by the system during the sending process

• Obtaining Token

API Response Codes