Refuse a Call
Refuse a call ringing for the team member. The call ends for everyone it rang.
Refuses a call ringing for the team member. The call ends for everyone it rang.
Endpoint
POST https://public.doubletick.io/v1/call/person/{callId}/decline
Authentication
Include your API key in the Authorization header.
| Header | Value |
|---|---|
| Authorization | <your-api-key> |
| Content-Type | application/json |
NOTE
If you do not have your DoubleTick API Key, you can obtain it by following this guide link.
Request Body
| Field | Required | Notes |
|---|---|---|
agentNumber | yes | The team member, by the phone number on their DoubleTick profile. |
Example Request
curl -X POST https://public.doubletick.io/v1/call/person/{callId}/decline \
-H 'Authorization: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{ "agentNumber": "<team member number>" }'
Example Response
{
"success": true,
"message": "Call declined",
"data": { ...the call... }
}
Things to Know
- Only for a call ringing for the team member. To hang up a call that was answered, or the team member's own call out, use End (
409 USE_END). - Safe to retry: on a call that is already over it answers
200with the call.
Error Responses
Besides the errors on every route (see Errors in the Overview):
| Status | reason | Message | When |
|---|---|---|---|
| 404 | NOT_FOUND | Call not found | No such team-member call in your organization. |
| 401 | UNAUTHORIZED | Your 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. |
| 400 | ANSWERED_ON_PHONE | This call is on the agent's phone: answer, decline or rejoin it there. | A PSTN call. |
| 403 | AGENT_NOT_PERMITTED | This team member cannot answer this call. | The team member has no access to the call's chat. |
| 403 | FORBIDDEN | This call did not ring for you | The call did not ring this team member. |
| 422 | — | Call cannot be declined by a different user | Another team member has accepted it. |
| 409 | USE_END | Only a call ringing for this team member can be declined: end it instead. | An answered call, or a call out. |
Rate Limit
60 a minute per organization and team member.
Updated about 2 hours ago
What’s Next
Keep polling so the team member is rung for the next call.
Did this page help you?