Whispir Callbacks APIs

Whispir Callbacks APIs

Publisher: Search Engine (Ursa)
Base URL: https://whispir-callbacks-mock.herokuapp.com/

Whispir's Callback functionality allows customers applications to receive responses to messages directly to their applications via a JSON or XML POST request from Whispir.

Customers can provide a URL to Whispir, and specify an authorization header or query parameter to provide Whispir authorization to access the provided callback service.

Customers can use this API to create new callback services, and update or delete existing callback services.

Callbacks can be invoked by including the supplied `callbackName` parameter in the request to the `messages` endpoint.

For example:

```
POST https://api.whispir.com/messages?apikey=abc123

{
"to" : "61400000000",
"subject" : "Demonstration Message",
"body" : "This is the sample SMS Content",
"callbackId" : "My Callback Service"
}
```

Every attempt to POST information to the callback URL is stored as a `call` against the particular Callback record.

Customers can query this information by making a `GET` request to the `/callbacks/{id}/calls` endpoint. This provides a list of both SUCCESS and FAILED calls to the specified callback.

In the event the customer would like to reprocess any FAILED callbacks in their system, they can consume the information using the `calls` endpoint, and once successfully SUCCESS, the particular call can be updated using the `PUT /callbacks/{id}/calls?id[]={id}` endpoint.

Making this update will update the status of the provided `call` IDs to `SUCCESS` so these will not be returned with the next query for FAILED calls.

*Note:* This swagger definition references `applications/json` as the content type that should be used. In a production capacity, the actual Accept and Content-Type headers should be:

- `application/vnd.whispir.api-callback-v1+json` for Callbacks endpoints
- `application/vnd.whispir.api-call-v1+json` for Calls endpoints

More information about Whispir's API Callbacks functionality can be found in the Whispir API Documentation available at https://whispir.github.io/api.

Available Platforms


DISCLAIMER: These SDKs are generated using publicly available descriptions of APIs that anyone has created. As such there are no guarantees for any of the SDKs below, or that this listing is maintained by or even related to the company it claims to be, unless explicitly specified.

C-Sharp


Portable Class Library Download Customise

A project for creating a C# class library (.dll) that can run on Windows, Silverlight and Windows Phone.

Download Documentation | View Older Versions

Objective-C


Cocoa Touch Static Library Download Customise

A foundation framework based template for building static library in Objective-C.

Download Documentation | View Older Versions

Java


Android Library (Gradle) Download Customise

A gradle based android library project, which can be used with Android Studio as well as command line based gradle build system.

Download Documentation | View Older Versions

Java Library (Eclipse) Download Customise

An eclipse based java library project, which can be used with JRE7.

Download Documentation | View Older Versions

Javascript


Angular JS Download Customise

An AngularJS library based on v1.3.0.

Download Documentation | View Older Versions

Node.js Download Customise

A Node.js npm package based on Node.js v0.12.4

Download Documentation | View Older Versions

PHP


PHP Library Download Customise

A php library based on PHP >= 5.3 and Composer dependency manager

Download Documentation | View Older Versions

Python


Python Library Download Customise

A Python library based on Python 2.7, that uses PIP as the dependency manager

Download Documentation | View Older Versions

Ruby


Ruby Gem Download Customise

A Ruby Gem based on Ruby >= 2.0.0

Download Documentation | View Older Versions

Go


Go Library Download Customise

Go language (v1.4), client library package that is compatible with command line tools as well as the Goclipse IDE.

Download Documentation | View Older Versions

All Reviews (0)


There are no reviews at the moment.

Users of this SDK (0)


There are no uses at the moment.

Rating

No Rating

Category

Other

Tags

No Tags