Browse Platform API
Platform APIEnterprise

Get a timer task

Copy

Get the complete configuration of a timer task.

HTTP request

POST {API_ADDRESS}/timer/get_timer_task

Request example

curl --request POST "${API_ADDRESS}/timer/get_timer_task" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"taskID":"task_001","userID":"user_001"}'

Request body

ParameterRequiredTypeDescription
taskIDYesstringTimer task ID.
userIDYesstringUser associated with the task.

Response

data.task contains the requested TimerTask.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Validate that the caller may access the target user's task.