Guides

Hang Up a Call

Hang up a call the team member is on, is placing, or has accepted.

Suggest Edits

Hangs up a call the team member is on, is placing, or has accepted. The call ends at once for everyone.

Endpoint

POST https://public.doubletick.io/v1/call/person/{callId}/end

Authentication

Include your API key in the Authorization header.

HeaderValue
Authorization<your-api-key>
Content-Typeapplication/json

📘

NOTE

If you do not have your DoubleTick API Key, you can obtain it by following this guide link.

Request Body

FieldRequiredNotes
agentNumberyesThe team member, by the phone number on their DoubleTick profile.

Example Request

curl -X POST https://public.doubletick.io/v1/call/person/{callId}/end \
  -H 'Authorization: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{ "agentNumber": "<team member number>" }'

Example Response

{
  "success": true,
  "message": "Call ended",
  "data": { ...the call... }
}

Things to Know

  • VOIP: call End, then close your own audio connection. If you only close your connection, the customer waits up to 60 seconds in silence for a rejoin.
  • DIRECT: hangs up both phones.
  • The call becomes END if it was answered, REJECT if it was still ringing.
  • On a call ringing for the team member that they have not accepted, use Decline (409 USE_DECLINE).
  • Safe to retry: on a call that is already over it answers 200 with the call.

Error Responses

Besides the errors on every route (see Errors in the Overview):

StatusreasonMessageWhen
404NOT_FOUNDCall not foundNo such team-member call in your organization.
401UNAUTHORIZEDYour organization does not have a calling license or add-on. Please contact [email protected]A WhatsApp call, and WhatsApp calling is not on your plan.
409USE_DECLINEThis call is ringing for this team member: accept or decline it.A ringing call the team member has not accepted.
422—Only the agent on the call can end it.A team member who is not on the call.
400—Simple2Call calls cannot be ended from the app; the call ends when a participant hangs upA number whose line cannot be hung up remotely.

Rate Limit

60 a minute per organization and team member.

Updated about 2 hours ago

What’s Next

Read the finished call for its duration, recording and end reason.

Did this page help you?