Stop Connection

POST {{base_url}}/v1/endpoint:connect

About this API

Stop currently active connection created using Telephony API for PSTN or SIP endpoint.

Prerequisite

  • You must have generated access token by executing Generate Token request under Authentication folder.
  • You should have executed Start Connection either using PSTN or SIP or if you have existing active connectionId which is not created using this Qodex collection then you will need to replace connection_id variable in request body with your connectionId.

connection_id

Last known connectionId for successful connection created using this Qodex collection. If you have existing active connectionId which is not created using this Qodex collection then you will need to replace connection_id variable in request body with your connectionId.

Request Body

{"operation"=>"stop", "connectionId"=>"{{connection_id}}"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
x-api-keystring