×

Description

Delete a single scheduled customer callback record using its unique identifier.

This API endpoint is used by supervisor or administrative applications to permanently remove an unwanted or completed callback from the system queue.

DELETE

<Protocol>://<IP_Domain_Name>:<port>/ameyorestapi/voice/customerCallbacks/{customerCallbackId}

Authentication

This API requires session-based authentication. A valid session token, generated upon successful supervisor or administrator login, must be passed in the request header.

Path Parameters

Parameter Type Required Description Example Value
customerCallbackId String Yes The unique identifier of the callback record to be deleted. d741-6904fad1-cm-eEcdnIb3-50833
 
  • Example Request
DELETE 'https://app3.ameyoemerge.in:8443/ameyorestapi/voice/customerCallbacks/d741-6904fad1-cm-eEcdnIb3-50833' \
--header 'sessionId: d741-6904fad1-ses-supervisor@exotel.in-DRjkyVX072gjShbiytGyb4d5pzwGGIWcJGA5AJeLaQWwYcf0pCWpLdMOapOCmKdVnNlr3vI64hURQt5Wr05OP1671bVtq7rPttDvedBzCEYvJXrl8E5Q-89219'

Example Response (200 OK)

A successful deletion returns a minimal response, indicating the operation was executed correctly.

Status Code Description
200 The request was successful, and the callback record has been deleted.

Successful Response Body

The response body will be the simple string "ok" (not a JSON object).

401 Unauthorized

Returned when the provided sessionId is missing, expired, or invalid.

500 Internal Server Error

Returned for an unexpected server-side issue. This can also occur if the system fails to interact with the database to execute the deletion.