API Overview
Message Callbacks
Status Codes
Use the JuggleIM REST API from your application backend to manage users, groups, conversations, and messages. The following sections describe request formats, authentication, and individual endpoints.
Requests are authenticated using shared custom headers.
Format
https://$api/$version/$command
| Parameter | Name | Description | |
|---|---|---|---|
| $api | API domain | Available after deploying the service in a private cloud. | |
| $version | Version | API version. | |
| $command | Command | Specific API endpoint. |
Request Headers
| Header | Required | Description | Notes |
|---|---|---|---|
| appkey | Yes | Unique application identifier. | |
| nonce | Yes | An 8-digit random number. | |
| timestamp | Yes | Timestamp in milliseconds. | |
| signature | Yes | SHA-1 signature. Calculate it strictly according to the signature rules. |
Signature Calculation
To calculate a signature, obtain the appsecret for the corresponding appkey when you create the application.
// The order must be exactly appsecret -> nonce -> timestamp
signature = SHA1({appsecret}{nonce}{timestamp})