Stay Reachable and See Calls

Keep a team member reachable for incoming WhatsApp calls, and list the calls ringing for them and the calls they are on.

Keeps a team member reachable for incoming WhatsApp calls, and lists the calls ringing for them and the calls they are on. Poll it every 2 seconds for each team member taking calls.

Endpoint

POST https://public.doubletick.io/v1/call/person/updates

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/updates \
  -H 'Authorization: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{ "agentNumber": "<team member number>" }'

Example Response

{
  "success": true,
  "message": "Call updates",
  "data": { "calls": [ ...calls... ] }
}

Each item in calls is a call (see The call object in the Overview).


How Being Rung Works

  • A team member can be rung only once they are reachable. Each poll, VOIP call out, accept or reconnect keeps them reachable for 24 hours.
  • When no team member is reachable, the caller hears busy at once.
  • If your app stops polling, the team member stays reachable until the 24 hours run out: callers ring for 60 seconds and then become a missed call.
  • A call ringing for the team member is listed with callDirection INCOMING and callStatus INITIATED; ringExpiresAt says until when it can be accepted.
  • The team member's own call out that is still ringing is not listed; its id is in the call-out reply.
  • Incoming-call webhook: CALL_INCOMING_INITIATED carries the same callId, but it is also sent for a call turned away busy, which rang no one. Accepting such a call answers 404. Use this poll to know what is ringing.

Error Responses

The errors on every route (see Errors in the Overview), and the calling-license 401 when WhatsApp calling is not on your plan.


Rate Limit

60 a minute per organization and team member. Polling every 2 seconds uses 30.


What’s Next

When a call shows up ringing for the team member, answer it or refuse it.

Did this page help you?