Links

Overview

The Chat Platform API allows you to interact directly with data resources related to your application's chat activities. It uses standard HTTP protocols, with JSON payloads returned in response to requests, and is based on RESTful principles. This API offers more flexibility and added functionality compared to the native SDKs, which handle many requests and responses on the client side.

Base URL

MinChat API calls are made to the following URL:
https://minchat.dirtservers.com/api/v1

Headers

A typical HTTP request to the Chat API includes the following headers:
Authorization: YOUR_API_KEY
The API Key can be found on the Minchat dashboard.
All of your API requests must be made over HTTPS. Plain HTTP calls will fail. API requests without the API Key will also fail.

Response Codes

The MinChat API uses standard HTTP status codes to indicate the success or failure of API calls.
200
API call was successful.
400
You've made an error in your request. See the message field in the response for details.
401
The authentication credentials provided were incorrect. (i.e invalid API Key).
404
Unknown API end point.
500
A temporary internal server error.

API Endpoints

In MinChat, a User is a person that uses your app. Typically, you will have one MinChat User for each user in your own database.
get
https://minchat.dirtservers.com/api/v1
/chats
Get Conversations
get
https://minchat.dirtservers.com/api/v1
/chat
Get Conversation
get
https://minchat.dirtservers.com/api/v1
/messages
Get Messages
post
https://minchat.dirtservers.com/api/v1
/message
Send Message
Last modified 4mo ago