This API enables Organizations to import external customer satisfaction surveys (CSAT) into the CommBox platform, attaching them to existing conversations and tagging the conversation appropriately.
You'll need to open a designated channel in the Customer Satisfaction Survey Module. The channel ID will be the value for the surveyStreamId parameter in the API request. Click here to learn more.
Note:
- The example below is for a single-question survey. Multiple-question arrays are also supported.
- The first answer always represents the highest satisfaction score (100%), while the last answer represents the lowest satisfaction score (0%). Scores for intermediate answers are distributed evenly between these values.
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.
A CommBox generated number for the conversation
The ID of the Customer Satisfaction Survey channel
Unique identifier of the survey question
The survey question was presented to the customer
Available answer choices for the user to select from
The answer selected by the customer
OK
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not found - The requested resource is not found
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Server Error - The server could not return the representation due to an internal server error