Messages

Web and social publishing

The Whispir API supports publishing to web, RSS and social media through existing configurations set up in the Whispir platform

NOTE: Social Publishing and some features of the Web Publishing require configuration before being available. Please contact the Whispir Support Team to explore the full offer for web and socials

If your existing Whispir setup already allows you to publish to these destinations, you can simply specify the information in the message and it will be published automatically

Web publishing

The Web section is used to publish information to Whispir’s Contact Portal [or Whispir Community] or to a predefined web destination such as your company intranet. Whispir can automatically export this content as plain text or HTML to a location for you to either iFrame into your webpage or include via AJAX

Social publishing

Whispir can publish content to your Twitter and Facebook walls. Other socials can be available upon request

  • JSON
  • XML

Web and Social Messaging

Example: Social media request/response

{{codeStart}}

POST https://api.<region>.whispir.com/messages

Authorization: Basic am9obi5zbWl0aDpteXBhc3N3b3Jk

x-api-key: your_api_key

Content-Type: application/vnd.whispir.message-v1+json

{

"to" : "61400400400",

"subject" : "Test web message",

"web" : {

"body" : "This is the body of the web content",

"type" : "text/plain"

},

"social" : {

"social" : [{

"id" : "social",

"body" : "This is the content of social message for Twitter"

}, {

"id" : "social_long",

"body" : "This is the content of social message for Facebook"

}, {

"id" : "socialType",

"body" : "This is the content for another social"

}]

}

}

{{codeEnd}}

Request Body Details

to

(required)

String

In this case it won't play any role but it's mandatory because we may have other channels in need to specify the recipient

subject

(required)

String

A description of the message to be published

body

(required)

String

Depending on the object where it is contained in the example above it is respectively the web content, the content for Twitter or the content for Facebook