Browse Platform API
Platform APIEnterprise

Delete a timer task

Copy

Delete a specified timer task owned by a user.

HTTP request

POST {API_ADDRESS}/timer/delete_timer_task

Request example

curl --request POST "${API_ADDRESS}/timer/delete_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

The common response has errCode: 0 when the task was deleted successfully.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Do not assume deletion cancels a callback that has already started executing.