curl --request POST \
--url https://apix.us.amity.co/api/v5/sessions/bot \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"deviceId": "<string>",
"deviceInfo": {
"kind": "ios",
"model": "<string>",
"sdkVersion": "<string>"
}
}
'{
"accessToken": "<string>",
"issuedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"users": [
{
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>",
"path": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"isDeleted": true
}
],
"roles": [],
"files": [],
"lastCachePurge": "2023-11-07T05:31:56Z",
"userType": "bot"
}Register a bot session for SEO crawlers. Bot users have read-only access and are optimized for SEO crawling.
curl --request POST \
--url https://apix.us.amity.co/api/v5/sessions/bot \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"deviceId": "<string>",
"deviceInfo": {
"kind": "ios",
"model": "<string>",
"sdkVersion": "<string>"
}
}
'{
"accessToken": "<string>",
"issuedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"users": [
{
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>",
"path": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"isDeleted": true
}
],
"roles": [],
"files": [],
"lastCachePurge": "2023-11-07T05:31:56Z",
"userType": "bot"
}API key for network authentication
Information about bot user and devices that they use to connect. Bot users have read-only access and are typically used for SEO crawlers and automated systems.
accessToken expires in 30 days by default.
Session Information with access token and user data
JWT access token for API authentication
Token issuance timestamp
Token expiration timestamp
User information array
Show child attributes
User roles array
Show child attributes
[]Associated files array
Show child attributes
[]Date of the last cache purge
Type of user (e.g., signed-in, visitor, bot)
signed-in, visitor, bot "bot"