Browse the side navigation menu for endpoint and method definitions.

Phone numbers

Phone numbers must be in a specific international format. This resource allows you to look up a phone number to obtain basic details including it's correct format, where it is located, and whether it is able to receive SMS surveys.

PSTN Transfer Reservations

A PSTN Transfer Reservation provides a way for you to give Mindful Feedback a unique ID and set of attributes for a future incoming call when SIP transfers are not available. In response, Feedback will send back an inbound_number field containing a number to which you can transfer a caller. The call will be assigned the attributes of the API request you just performed.

As a basic example, your survey might support multiple languages. However, a PSTN transfer has no way to notify Feedback of the incoming caller's language. That's where the PSTN Transfer Reservation comes in, telling Feedback that a call is about to arrive where the respondent_language attribute holds a value of "en-US". Feedback sends back the phone number to which the caller should be transferred, and when the caller arrives, Feedback expects it and can conduct the survey in the appropriate language.

SIP Transfer Reservations

A SIP Transfer Reservation provides a way for you to give Feedback information about an incoming SIP call.

This functionality allows you to make an API call to Feedback before transferring a SIP call, so that Feedback is expecting the call and can associate it with data from the API request.