Route Management
Get User IM Address
Get the IM connection address for users
GET
Overview
Get the IM connection address for users, including TCP, WebSocket, and WebSocket Secure addresses.Query Parameters
Whether to return intranet address
0- Return external network address1- Return internal network address
Response Fields
TCP connection address, format:
host:portWebSocket connection address, format:
ws://host:portWebSocket Secure connection address, format:
wss://host:portStatus Codes
| Status Code | Description |
|---|---|
| 200 | Successfully retrieved IM connection address |
| 500 | Internal server error |
Use Cases
Client Connection Setup
Dynamic Connection Discovery:Load Balancing
Multiple Server Discovery:Environment-based Connection
Internal vs External Network:Connection Failover
Automatic Failover:Mobile App Integration
Platform-specific Connection:Best Practices
- Connection Type Selection: Choose appropriate connection type based on environment (HTTP/HTTPS)
- Failover Strategy: Implement failover mechanism for high availability
- Network Detection: Detect internal vs external network for optimal performance
- Connection Testing: Test connectivity before establishing full connection
- Caching: Cache connection addresses to reduce API calls
- Error Handling: Handle network errors gracefully with retry logic
- Security: Use secure connections (WSS) in production environments

