API Overview
Message Callbacks
Status Codes
Overview
Sign-in API. Sign in with an account, phone number, or email address plus password.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/login
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| account | string | No | Account. Letters and digits are recommended; length: 5–20 characters. Provide one of account, phone, or email. | |
| phone | string | No | Phone number | |
| string | No | Email address | ||
| password | string | Yes | Account password |
Request example
POST /jim/login HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"account":"username",
"password":"xxxxxx"
}
Response example
{
"code":0,
"msg":"sucess",
"data":{
"user_id":"userid1",
"authorization":"xxxxxxxxx",
"nickname":"user1",
"avatar":"xxxxxxxx",
"status":0,
"im_token":"xxxxxxxxx"
}
}