acapps

GET /message/get HTTP/1.1
HTTP: api.zipwhip.com

Parameters:
session={session}
uuid={Message ID}

$curl https://api.zipwhip.com/message/get
  -d session=[sessionKey]
  –d uuid=[id]

acapps

When installing Web Hooks the first step is to call app/install. One of the return values is the installedAppId. You can store this value, so you can make changes to your Web Hooks in the future. You can however, just use app/list and then snag the installedAppId from the payload.

INSTALL:

NOTE: Web calls do not take JSON as a single input. The settings parameter, however, does take JSON as an input.

$curl -X POST https://api.zipwhip.com/app/install
  -d appId=4501
  -d session=[SessionKey]
  -d settings=%7B%22%2Fsignal%2Fmessage%2Freceive%22%3A%22http%3A%2F%2Fhosteddomain.com%2Fmessage%2Freceive%22%7D

acapps

Example of Canadian Number:
$curl https://api.zipwhip.com/user/login
  -d username=%2B15555551212
  -d password=default
  
It is important to note that on Canadian numbers that you must put the number into E.164 format.

Standard user/login
$curl https://api.zipwhip.com/user/login
  -d username=[phonenumber]

acapps

$curl http://api.zipwhip.com/contact/list
  -d session=[sessionKey]
  –d pageSize=1
  
Where pages is the total number of contacts associated with the account.
In the example below the account has 89 contacts.
  
Response:
{
  "total":1,

acapps

function findByText(_tag, _search, _value)
{
  var aTags = document.getElementsByTagName(_tag);
  var i = 0;
    
  for (i = 0; i < aTags.length; i++)
  {
    if (aTags[i].textContent == _search)
    {
      aTags[i].innerText = _value;

acapps

Deeplink, single sign on, into a Zipwhip Webapp.

GET /session/v2/deeplink?session=[sessionKey]&url=[http://subdomain.zipwhip.com] HTTP/1.1
HOST: api.zipwhip.com

sessionKey is obtained by performing a user/login
url is the link to the webapp. NOTE: AT THIS TIME THE URL MUST BE A SUBDOMAIN OF ZIPWHIP

Webcall supports HTTPS.

acapps

$curl https://vendor.zipwhip.com/message/send
  -d vendorKey=[your vendor key]
  -d destinationAddress=[recipients phone number]
  -d sourceAddress=[the sender's phone number]
  -d body=[message body]

acapps

$curl https://api.zipwhip.com/app/install
  -d session=[sessionKey]
  –d appId=4601

This will add the Keyword option to the webapp.

Response:
{
  "success": true,
  "response": {

acapps

$ curl https://api.zipwhip.com/password/change
  -d session=[session]
  -d currentPassword=[existingPassword]
  -d password=[newDesiredPassword]
  
Response:
{
  "response":"",
  "sessions":null,
  "success":true

acapps

curl https://api.zipwhip.com/user/password/forgot
  -d mobileNumber=[Phone Number]

Response:
{
  "success":true,
  "response":null
}