Volcano API
🚀 API Endpoints

đŸ’Ŧ Instant Messaging

Chat and messaging system endpoints. 3 endpoints available.

đŸŽ¯ Quick Stats

📊 Methods

  • 📝 POST: 2 endpoints
  • 🔍 GET: 1 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

âš ī¸ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

MethodEndpointDescription
📝 POST/im/registerRegister IM users
📝 POST/im/sendSend IM message
🔍 GET/im/{provider}/historyFetch chat history

📖 Detailed Documentation

Register IM users

POST/im/register
Full URL
https://api.market.decenctype.com/im/register

🔐 Authentication: Required (see authentication section above)

Description: Register IM users

Operation ID: registerUser

Response Status:

  • ✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/im/register" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Send IM message

POST/im/send
Full URL
https://api.market.decenctype.com/im/send

🔐 Authentication: Required (see authentication section above)

Description: Send IM message

Operation ID: sendMessage

Response Status:

  • ✅ 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/im/send" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Fetch chat history

GET/im/{provider}/history
Full URL
https://api.market.decenctype.com/im/{provider}/history

đŸŽ¯ Path Parameters

  • provider (string) - ✅ Required: No description

Description: Fetch chat history

Operation ID: getChatHistory

Response Status:

  • ✅ 200: Success

📝 Example Request

curl -X GET "https://api.market.decenctype.com/im/example-id/history" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"