stopcall
  • 16 Oct 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

stopcall

  • Dark
    Light
  • PDF

Article summary

Post
/api/v1/{api_key}/click2call_hangup

End the agent's call initiated by the click2call API. Agents are identified by their extensions in the agent parameter.

Path parameters
api_key
stringRequired
Example{contact_center_api_key}
Body parameters
agent
string Required
Responses
204

All parameters are valid and the API call ends

400

Incorrect body parameters

example1

Error1

No active calls

{
  "error": "No active calls"
}
example2

Error2

Call rate limit exceeded

{
  "error": "Rate limit exceeded"
}
example3

Error3

Invalid agent's extension

{
  "error": "Invalid agent's extension"
}
Example{ "error": "No active calls" }
403

Invalid api_key

example1

Error1

Invalid API key

{
  "error": "Invalid api_key"
}
Example{ "error": "Invalid api_key" }

Was this article helpful?

What's Next