Call

/v0.1/HangupCall/

Hangs up a specific call

post/v0.1/HangupCall/

Request

Base URL
https://eqivo.org (the document declares no server; this is the origin it was published from)
Auth
HTTP basic
TypeScript
https://skmtc.dev/eqivo/apis/eqivo-api/docs/v0.1/HangupCall/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

CallUUIDstring

Unique identifier of the call (when established); this parameter is mutually exclusive with RequestUUID

RequestUUIDstring

Unique identifier of the API request (when the call is not established yet); this parameter is mutually exclusive with CallUUID

Example request

{
  "CallUUID": "b0519011-6987-47c8-9270-a820e0978acd",
  "RequestUUID": "c059b96b-04d8-414b-920c-7b373bff916e"
}

Response

Message'Hangup Call Executed' | 'CallUUID or RequestUUID Parameter must be present' | 'Both CallUUID and RequestUUID Parameters cannot be present' | 'Hangup Call Failed' required

Response message

Successboolean required

Whether the request was successful or not

Example response

{
  "Message": "Hangup Call Executed",
  "Success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.