Browse Platform API
Platform APIEnterprise

Get the group application badge count

Copy

Get the group-application badge count currently displayed for a user. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/group/get_group_application_badge_count

Request example

curl --request POST "${API_ADDRESS}/group/get_group_application_badge_count" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{"userID":"user_001"}'
Enterprise: This endpoint requires the corresponding OpenIM Enterprise services.

Request body

ParameterRequiredTypeDescription
userIDYesstringOpenIM user ID.

Response

{"errCode":0,"errMsg":"","errDlt":"","data":{"count":1}}

Response properties

PropertyTypeDescription
data.countintCurrent group-application badge count.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • The caller must validate its authority to read the user's application state.