Browse the API reference

Calls

Cancel a call

View as Markdown
posthttps://www.getrevox.com/api/call/{id}/cancel

Stop a call's future attempts. A call that has not started dialing yet is cancelled right away. A call whose attempt is already in progress is not hung up: that attempt finishes, and no retry or callback is scheduled after it. Returns 409 when the call is already in a terminal status.

Path parameters

  • idstringrequired

Responses

200Success
  • successbooleanrequired
400Invalid request: the body or a parameter failed validation
  • messagestring
  • errorstring
  • bodyErrorsobject

    The validation errors returned from the API.

    Show 1 field
    • issuesarray of objectrequired
      Show 3 fields
      • patharray of one ofrequired
        Show 2 variants
        1. One ofstringstring

        2. One ofnumbernumber

      • messagestringrequired
      • codestring
404Not found in your organization
  • messagestring
  • errorstring
  • bodyErrorsobject

    The validation errors returned from the API.

    Show 1 field
    • issuesarray of objectrequired
      Show 3 fields
      • patharray of one ofrequired
        Show 2 variants
        1. One ofstringstring

        2. One ofnumbernumber

      • messagestringrequired
      • codestring
409Conflict with the resource's current state
  • messagestring
  • errorstring
  • bodyErrorsobject

    The validation errors returned from the API.

    Show 1 field
    • issuesarray of objectrequired
      Show 3 fields
      • patharray of one ofrequired
        Show 2 variants
        1. One ofstringstring

        2. One ofnumbernumber

      • messagestringrequired
      • codestring