hangup

End the call with an optional reason.

hangup

objectrequired

An object that contains the hangup parameters.

hangup Parameters

hangup.reason

"hangup" | "busy" | "decline"

Hangup reason

Examples

No parameters

YAML

version: 1.0.0
sections:
  main:
    - answer: {}
    - hangup: {}

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "answer": {}
      },
      {
        "hangup": {}
      }
    ]
  }
}

Set a hangup reason

YAML

version: 1.0.0
sections:
  main:
    - answer: {}
    - hangup:
        reason: "busy"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "answer": {}
      },
      {
        "hangup": {
          "reason": "busy"
        }
      }
    ]
  }
}