call

[BETA] end call

Ends the active call (or the call with callId), whether it is still ringing or already connected. Without a matching call the answer is data.status: error with message: failed to end call and an explanation. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/end-call

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/end-call
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

callIdstring

The call to act on. Omit to use the instance's only active call.

Example request

{
  "callId": "00E61C7AAD3559F3AFC223D4E3FC1914"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: the id of the call that was ended.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "callId": "00E61C7AAD3559F3AFC223D4E3FC1914"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.