API Documentation

Creating new conversation

HTTP GET Endpoint

GET https://linkchatter.com/api/v1/get-link

Example response

{
  "conversation_id": "mde0odk2odm3odk0mjexmjcwm",
  "key": "1814c55ade47aa623aa83a8b5681bf58597a8cfec37f6919b8db6f"
}

Link to conversation can be build by following formula

https://linkchatter.com/chat/{conversation_id}

So that the URL will look like this

https://linkchatter.com/chat/mde0odk2odm3odk0mjexmjcwm

In that case, user have to input authorisation key on chat web page

Attaching a key to the link

There is also possibility to share link with key

https://linkchatter.com/chat/{conversation_id}:{key}

https://linkchatter.com/chat/mde0odk2odm3odk0mjexmjcwm:1814c55ade47aa623aa83a8b5681bf58597a8cfec37f6919b8db6f

Automatically set nickname

If you wish to set nickname for users, you can do it by simply adding :{nickname} to end of the link

https://linkchatter.com/chat/{conversation_id}:{key}:{nickname}

https://linkchatter.com/chat/mde0odk2odm3odk0mjexmjcwm:1814c55ade47aa623aa83a8b5681bf58597a8cfec37f6919b8db6f:nickname

Posting message via API

HTTP POST Endpoint

POST https://linkchatter.com/api/v1/message

Endpoint accept only json data

{
  "conversation_id":"mde0odk3ndm1mdu1mdexmjcwm",
  "key":"4260c795e9b4e9da5b38b7ab17c6dbc8908b52bc5f5b723c9d553f",
  "message":"hello chatter from API :)",
  "nickname":"john doe"
}

Necessary field

• {conversation_id} - (string) conversation identificator gained from /get-link endpoint
• {key} - (string) authorisation key gained from /get-link endpoint
• {message} - (string) message to send
• {nickname} - (string) nickname displayed next to message

If message was send, response will look this

{
  "message": "send"
}