HelpChat Server SDK interface
HTTP interfaces for sending messages to one user, several users or whole departments.
Info
The SDK interface requires server version 12.4.3 or later.
1. Sending to one or more users
Request format:
http
http://127.0.0.1:6888/api/v12/sdk/send?recv=1000&send=1001&msg=HelloParameters
| Parameter | Description |
|---|---|
| 127.0.0.1:6888 | Replace with the IP address of the server computer and the port of the HelpChat Data process |
| recv | Recipient UID; to send to several people, separate the UIDs with commas |
| send | Sender UID |
| msg | Message text, up to 1024 bytes |
2. Broadcasting to departments or to all (online) accounts
Request format:
http
http://127.0.0.1:6888/api/v12/sdk/broadcast?dept=1,2,3&send=1001&msg=HelloParameters
| Parameter | Description |
|---|---|
| dept | Department DIDs, separated by commas. dept=all sends to all accounts; dept=online sends only to online users |
| send | Sender UID |
| msg | Message text, up to 1024 bytes |
3. Message receiving interface
Enterprise edition VIP feature
This interface is available only to VIP
users who have purchased the enterprise edition. When free users call it, a watermark is added to the message. For details, please contact us.