ListenPort API Beta

Introduction

The ListenPort API is built around REST. Write and test application using any HTTP client. JSON will be returned in all responses from the API, including errors.

Base URL

All URLs referenced in the documentation have the following base:

Authentication

All requests require your API credentials, which you can find under Account Settings.

Property Description

api_key

Required - Your API Key. Example: api_key=lpr0ck5

api_secret

Required - Your API Secret. Example: api_secret=1l4ksi4k

Errors

ListenPort uses conventional HTTP response codes to indicate success or failure of the API request.

  • 200 OK: The request was successful and a response body contains the representation requested
  • 404 NOT FOUND: The requested item doesn't exist.
  • 405 METHOD NOT ALLOWED: The requested method is not allowed.
  • 500 INTERNAL SERVER ERROR: Something went wrong on our end.

Methods

Business Profiles

Get a list of all your business profiles hosted on ListenPort. This will return such things as any listed addresses, phone numbers, and emails.

Get one your specific business profiles hosted on ListenPort. This will return such things as any listed addresses, phone numbers, and emails.

Property Description

street_1

string

Update the business locations street address.

street_2

string

Update the business locations unit/apt number.

city

string

Update the business locations city.

state

string

Update the business locations state. Abbreviation required. Limited to 2 characters. .

zip

string

Update the business locations zip code. Requires a 5 character string.

phone

string

Add a valid business phone number.

email

string

Add a valid business email address.

website

string

Update the businesses website URL. This will be public to help drive traffic.

auto_response

string

Set a auto-response associated with a business location. This requires a ID from one of the business create auto-responses. You can get an available ID via the auto-response services.

Feedback

This will return a object with the most recent feedback from all of your businesses hosted on ListenPort. The return is limited to 50.

This will return a object with the most recent feedback from a specific profile businesses hosted on ListenPort. The return is limited to 50.

To return a specific parent message and all of it's children. This requires a parent messages ID.

Property Description

type

string

What type or message is this or how does the customer want to receive any replies. May be email or sms.

from

string

May be an email address or sms number. This is how the customer will receive any replies.

feedback

string

The feedback or review the customer is providing.

Property Description

archive

boolean

Archive feedback.

flagged

boolean

Flag feedback if you need to go back to it later.

spam

boolean

Mark feedback as spam. Once marked as spam you won't receive feedback from this person again.

read

boolean

Mark feedback as read.

favorited

boolean

Mark feedback as a favorite.

closed

boolean

Mark feedback as closed. Once doing so feedback from this customer will come in as a need feedback stream.

Reply

Property Description

reply

string

The reply to be sent to the customer.

Surveys

Property Description

name

string

Give the survey a unique name.

message

string

A quick message that is sent along with the survey URL.

completion_message

string

A message to the customer after they complete a survey.

questions

associative array

An associative array of questions with the associated question type.

ID Type Description
1 Customer Input Get a text response.
2 Star Rating Get a rating of 1-5 stars.
3 Emotional Rating Find out how much a customer likes or dislikes something.
4 Yes or No Get a simple yes or no answer.

Example:

Array

(

[0] => Array

(

[question] => How would you rate our service?

[type] => 3

)

[1] => Array

(

[question] => Anyting we can improve on?

[type] => 1

)

)