Windu is an open source messaging platform

• Request OAuth token

    curl -X POST -d "grant_type=password&username=<user>&password=<password>&client_id=RoVMZF1EIpC2vcfGC864gr4NZsv0mJlyPlE3gtQY" https://windu.herokuapp.com/o/token/
  

• Refreshing your token

    curl -X POST -d "grant_type=refresh_token&refresh_token=<refresh_token>&client_id=RoVMZF1EIpC2vcfGC864gr4NZsv0mJlyPlE3gtQY" https://windu.herokuapp.com/o/token/
  

• Using your token

  You will need send the Authentication header for every request, the next examples will omit the authentication header only for the sake of cleanliness.

    curl -H "Authorization: Bearer <Token>" https://windu.herokuapp.com/api/call
  

An account is linked to your number, in order to use Windu API you need to add and register an account.

With exception of create-account every method accept an optional account=000000 parameter, if you don't provide any account the first account will be used.

• Creating account, you will receive a SMS with the code to register your account

    curl -X POST -d "account=000000000&nickname=John Lennon" https://windu.herokuapp.com/api/account/create-account/
  

• If you already added an account, but want to receive a new SMS code to register:

    curl -X POST -d "account=000000000" https://windu.herokuapp.com/api/account/request-sms-code/
  

• Or if you want to receive a voice call:

    curl -X POST -d "account=000000000" https://windu.herokuapp.com/api/account/request-voice-code/
  

• After receive your code you need to register your account:

    curl -X POST -d "code=<received code>" https://windu.herokuapp.com/api/account/register-code/
  

• If you want to remove your account:

    curl -X POST -d "account=000000000&feedback=cool" https://windu.herokuapp.com/api/account/remove-account/
  

• Get account status message:

    curl -X GET https://windu.herokuapp.com/api/account/status-message/
  

• Update account status message:

    curl -X POST -d "status_message=😍😍😍😍" https://windu.herokuapp.com/api/account/status-message/
  

• Get profile photo:

    curl -X GET https://windu.herokuapp.com/api/account/profile-photo/
  

• Update profile photo:

    curl -X POST -F "photo=@photo.jpg" https://windu.herokuapp.com/api/account/profile-photo/
  

• Remove profile photo:

    curl -X DELETE https://windu.herokuapp.com/api/account/profile-photo/
  

• Get current connected status:

    curl -X GET https://windu.herokuapp.com/api/account/connected-status/
  

• Update connected status to online :

    curl -X POST -d "connected_status=online" https://windu.herokuapp.com/api/account/connected-status/
  

• Get current nickname:

    curl -X GET https://windu.herokuapp.com/api/account/nickname/
  

• Update your nickname (The nickname will appear on your notifications):

    curl -X POST -d "nickname=🚚🚎MyNick🚒" https://windu.herokuapp.com/api/account/nickname/
  

• Get current privacy settings:

    curl -X GET https://windu.herokuapp.com/api/account/privacy-settings/
  

• Update your privacy settings (status_message, photo, last_seen) possible values none, contacts and all :

    curl -X POST -d "photo=contacts&status_message=all" https://windu.herokuapp.com/api/account/privacy-settings/
  

You need to import or add your contacts before use any Windu method that interacts with any contact (photos, messages, groups, status).

###Adding/Importing/Removing/Listing contacts

• Adding contact:

  This method is to add a single contact, if you need to add in bulk use import-contacts instead. (Adding a contact will sync all contacts)

    curl -X POST -d "contact_id=XXXXXX&first_name=John Malkovich" https://windu.herokuapp.com/api/contacts/add-contact/
  

• Importing contacts:

  This method will import and REPLACE ALL your contacts (Importing will sync all contacts)

    curl -X POST -H "Content-Type: application/json" https://windu.herokuapp.com/api/contacts/import-contacts/ -d "{\"contacts\":[{\"contact_id\":\"3333333\",\"first_name\":\"John\"},{\"contact_id\":\"11111111\",\"first_name\":\"Tony\",\"last_name\":\"Stark\"},{\"contact_id\":\"22222222\",\"first_name\":\"Hulk\"}]}"
  

  Why no merge-contacts?

  • Merge is tricky (specially handling the remove), and lead to ghost records, you can do the merge yourself, listing all contacts and them, importing the merged result.

• Listing all contacts:

  List all contacts from your account:

    curl -X GET https://windu.herokuapp.com/api/contacts/
  

• Show contact info:

  Show contact information:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/
  

• Updating contacts:

  This method will only update the first_name and/or last_name no sync will happen.

    curl -X PATCH -d "first_name=Jon Arbuckle" https://windu.herokuapp.com/api/contacts/<contact-id>/
  

• Remove contact:

  This method is to remove a single contact, if you need to remove in bulk use remove-contacts instead. (Removing a contact will sync all contacts)

    curl -X DELETE https://windu.herokuapp.com/api/contacts/<contact-id>/
  

• Remove several contacts:

  (Removing contacts will sync all contacts)

    curl -X POST -H "Content-Type: application/json" -d "{\"contacts\":[\"XXXXXX\",\"YYYYYY\",\"ZZZZZZZ\"]}" https://windu.herokuapp.com/api/contacts/remove-contacts/
  

###Syncing

• Force syncing your contacts:

  Your contacts are automatically synced every time you add, remove or import any contact, so you normally DONT'T NEED THIS METHOD. This is just in case you need for some reason force re-sync all contacts:

    curl -X POST https://windu.herokuapp.com/api/contacts/force-sync/
  

##Status Message, Connected Status and Photo

###Status Message

• Get contact latest status message:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/status-message/
  

• Get contact status message history:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/status-message-history/
  

• Get all contacts statuses messages:

    curl -X GET https://windu.herokuapp.com/api/contacts/statuses-messages/
  

Contact presence and last seen will only work if YOUR connected status is online, otherwise you will get an out of date value.

• Get contact connected status online or offline, if the connected status is offline this will also return the last-seen:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/connected-status/
  

• Get connected status from ALL your contacts:

    curl -X GET https://windu.herokuapp.com/api/contacts/connected-statuses/
  

The profile photo method will return the contact photo as Content-Type image/jpeg, to retrieve the photo as url use the methods ended by -url sufix.

The profile photo can be retrived as preview or full. The preview photo will be much smaller and much faster to be retrieved.

• Preview photo

• Get contact preview profile photo URL:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/preview-photo-url/
  

• Get contact preview profile photo history URLs:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/preview-photo-history-urls/
  

• Get preview profile photo URL from ALL contacts:

    curl -X GET https://windu.herokuapp.com/api/contacts/preview-photos-urls/
  

• ####Full photo

• Get contact profile photo URL:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/photo-url/
  

• Get contact profile photo history URLs:

    curl -X GET https://windu.herokuapp.com/api/contacts/<contact-id>/photo-history-urls/
  

• Get profile photo URLs from ALL contacts:

    curl -X GET https://windu.herokuapp.com/api/contacts/photos-urls/
  

###Blocking/Unblocking

The blocked number doesn't need to be synced, you can block any arbitrary number.

• To block a number/contact:

    curl -X POST https://windu.herokuapp.com/api/contacts/<contact-id>/block/
  

• To unblock a number/contact:

    curl -X POST https://windu.herokuapp.com/api/contacts/<contact-id>/unblock/
  

• To get a list of blocked numbers:

    curl -X GET https://windu.herokuapp.com/api/contacts/blocked-list/
  

• Block a list of numbers:

  (This will replace all current blocked numbers)

    curl -X POST -H "Content-Type: application/json" -d "{\"numbers\":[\"XXXXXX\",\"YYYYYY\",\"ZZZZZZZ\"]}" https://windu.herokuapp.com/api/contacts/blocked-list/
  

The response of a send message request will contain the message-id which you can use later query when the message was delivered or read.

For Media messages (Image, Video and Voice/Audio) you can either pass the parameter as an URL (url=http://x.o/myfile.jpg) or as uploaded file -F "filename=@photo.jpg"

• Sending a text message:

    curl -X POST -d "message=😍&contact=XXXXXXX" https://windu.herokuapp.com/api/messages/send-message/
  

• Sending an image (uploaded):

    curl -X POST -F "caption=Cool Image☺️" -F"contact=XXXXXXX" -F "filename=@photo.jpg"  https://windu.herokuapp.com/api/messages/send-image/
  

  From URL:

    curl -X POST -d "caption=Cool Image😏&contact=XXXXXXXurl=http://i.imgur.com/Vi4wcC3.jpg" https://windu.herokuapp.com/api/messages/send-image/
  

• Send location message:

    curl -X POST -d "caption=Cool Place🗼&contact=XXXXXXXlatitude=48.8571&longitude=2.2943" https://windu.herokuapp.com/api/messages/send-location/
  

• Send voice/audio message (valid extensions: 3gp, caf, mp3, ogg, aif, aac, m4a):

• Sending a voice message (uploaded):

    curl -X POST  -F"contact=XXXXXXX" -F "filename=@voice.aac"  https://windu.herokuapp.com/api/messages/send-voice/
  

  From URL:

    curl -X POST -d "contact=XXXXXXX&url=http://a.clyp.it/isks2.mp3" https://windu.herokuapp.com/api/messages/send-voice/
  

• Sending an audio message (uploaded):

    curl -X POST  -F"contact=XXXXXXX" -F "filename=@voice.aac"  https://windu.herokuapp.com/api/messages/send-audio/
  

  From URL:

    curl -X POST -d "contact=XXXXXXX&url=http://a.clyp.it/isks2.mp3" https://windu.herokuapp.com/api/messages/send-audio/
  

• Send video message (valid extensions: 3gp, mp4, mov, avi]):

• Sending a video message (uploaded):

    curl -X POST  -F"contact=XXXXXXX" -F "filename=@video.mp4"  https://windu.herokuapp.com/api/messages/send-video/
  

  From URL:

    curl -X POST -d "contact=XXXXXXX&url=https://dl.dropboxusercontent.com/u/7386739/video.mp4" https://windu.herokuapp.com/api/messages/send-voice/
  

• Send vCard message:

    curl -X POST -d "contact=XXXXXXX&name=Johh Doe&vcard=BEGIN:VCARD(... all card content here)" https://windu.herokuapp.com/api/messages/send-vcard/
  

  From file:

    curl -X POST  -F"contact=XXXXXXX" -F"name=John" -F "filename=@johh.vcf"  https://windu.herokuapp.com/api/messages/send-vcard/
  

• Set typing status for a contact:

    curl -X POST -d "contact=XXXXXXX" https://windu.herokuapp.com/api/messages/set-typing/
  

• Set paused (typing) status for a contact:

    curl -X POST -d "contact=XXXXXXX" https://windu.herokuapp.com/api/messages/set-paused/
  

To retrive the message there are two different models, the chat list, which will contain all chats with groups or contact and the message list the actual messages received or send to/by a contact or a group.

• Getting the chat list:

    curl -X GET https://windu.herokuapp.com/api/message/chats/
  

• Get message list (including the sent ones)

  This method will retrive all messages (including the messages you sent):

  Parameters:

  after filter to retrive only messages after this timestamp

  limit limit the number of messages received

  offset skip the initial offset number of messages

  received_only set this to 1 to receive only messages received (and not the sent ones)

    curl -X GET -d "after=<time>" -d "limit=20" -d "offset=0" https://windu.herokuapp.com/api/messages/chats/<contact-id>/
  

  Result exemple:

    {
    	messages: [
    	{ 
    	  id: '12345',
    	  type: 't',
    	  received: true,
    	  text: 'Hello 😃'			
    	},
    	{ 
    	  id: '3445',
    	  type: 't',
    	  received: false,
    	  text: 'How you doing??'			
    	},
    	{ 
    	  id: '67789',
    	  type: 't',
    	  received: true,
    	  text: 'Quite good, and you?'
    	},
    	]
    }
  

All messages succefully received will be marked as delivered as soon the messages is fetched to the server.

• Update read receipts for all messages received from a contact before the date_limit:

    curl -X POST -d "contact=XXXXXXX&date_limit=2016-06-06 10:00:00" https://windu.herokuapp.com/api/messages/update-last-read/
  

If date_limit is suppressed the current date time will be used as limit.

• Get the latest delivered messages

    curl -X GET https://windu.herokuapp.com/api/messages/delivered/<contact-id>/?limit=20&offset=0&after=<time>
  

Parameters:

• after filter to retrive only messages delivered after this timestamp (default=1970-01-01)

• limit limit the number of messages received (default=20)

• offset skip the initial offset number of messages (default=0)

Example:

{"messages":
[
	{"delivered":"2016-05-20T05:52:45","id":"9E62584144AC9FE0692A4C"},
	{"delivered":"2016-05-20T06:06:37","id":"0060FC74577D7D63CF8E68"},
	{"delivered":"2016-05-20T06:07:47","id":"0060FC74577D7D63CF8E69"}
]}

• Get the latest read messages

This method will retrive all messages (including the messages you sent):

curl -X GET https://windu.herokuapp.com/api/messages/read/<contact-id>/?limit=20&offset=0&after=<time>

Parameters:

• after filter to retrive only messages read after this timestamp (default=1970-01-01)

• limit limit the number of messages received (default=20)

• offset skip the initial offset number of messages (default=0)

Example:

{"messages":
[
	{"read":"2016-05-20T05:52:45","id":"9E62584144AC9FE0692A4C"},
	{"read":"2016-05-20T06:06:37","id":"0060FC74577D7D63CF8E68"},
	{"read":"2016-05-20T06:07:47","id":"0060FC74577D7D63CF8E69"}
]}

##Groups

• Create a group. Parameters: subject and the participants. All participants need to be synced in your contact list.

    curl -X POST -H "Content-Type: application/json" https://windu.herokuapp.com/api/groups/create-group/  -d "{\"participants\":[\"XXXXXX\",\"YYYYYY\",\"ZZZZZZZ\"], "subject": "Cool group 👍"}"
  

• Get information about all groups you participate:

    curl -X GET https://windu.herokuapp.com/api/groups/info-all/ 
  

• Get information about one group:

    curl -X GET https://windu.herokuapp.com/api/groups/<group-id>/info/ 
  

• Change group suject:

    curl -X POST -d "subject=Even more cool group😎&group_id=<group-id>" https://windu.herokuapp.com/api/groups/subject/
  

• Group photo

• Get group preview photo URL:

    curl -X GET https://windu.herokuapp.com/api/groups/<group-id>/preview-photo-url/
  

• Get group photo URL:

    curl -X GET https://windu.herokuapp.com/api/groups/<group-id>/photo-url/
  

• Update group photo:

    curl -X POST -F "photo=@photo.jpg" https://windu.herokuapp.com/groups/<group-id>/photo/
  

• Remove group photo:

    curl -X DELETE https://windu.herokuapp.com/groups/<group-id>/photo/
  

• Add participant: Parameter: contact and group_id, remember the contact must be in your contact list:

  You need to be admin of the group in order to add participant

    curl -X POST -d "contact=XXXXXXX" https://windu.herokuapp.com/api/groups/<group-id>/add-participant/
  

• Remove participant: Parameter: contact and group_id:

  You need to be admin of the group in order to remove participant

    curl -X POST -d "contact=XXXXXXX" https://windu.herokuapp.com/api/groups/<group-id>/remove-participant/
  

• Promote participant: Parameter: contact:

  You need to be admin of the group in order to promote participant

    curl -X POST -d "contact=XXXXXXX" https://windu.herokuapp.com/api/groups/<group-id>/promote-participant/
  

• Demote participant: Parameter: contact:

  You need to be admin of the group in order to demote participant

    curl -X POST -d "contact=XXXXXXX" https://windu.herokuapp.com/api/groups/<group-id>/demote-participant/
  

• Laeve a group:

    curl -X POST -d "group_id=<group-id>" https://windu.herokuapp.com/api/groups/<group-id>/leave/