Help Docs

Make Call
CATEGORY: RINGQ API List
Description:

The Make Call API will perform the makeCall functionality when the call is ringing in one extension number.

Request URL:
http://<ringq FQDN>:8443/api/values/makeCall
Request Method:
POST
Request Parameters:
Parameter Name (* Mandatory) Data Type Description
action* String Specify the action to perform
agentextension* String Specify the agent extension number
pickupextension* String Specify the agent number whom have to pickup the call
Possible Errors:
HTTP Status Message Reason
400 Agent 102 does not participate in call or call is in incorrect state The given extension number is not having any calls
400 Currently no active calls in the pbx system There is no call in the RingQ right now
400 Check the extension 101 is currently registered or not, and also does not have any active calls The given extension is not registered or extension is in another call
400 Pickup Extension 1001 is not a valid RingQ Extension Pickup Extension 1001 is not a valid RingQ Extension
400 Agent Extension 1002 is not a valid RingQ Extension The agent extension is not in RingQ
400 Pickup extension is a mandatory one, it can't be null or empty The pickup extension is mandatory
400 Agent extension is a mandatory one, it can't be null or empty The agent extension is mandatory
401 Unauthorized, does not have permission for Pickup Call Check whether the pickup call is enabled in omni channel

Generate API

Sample Response
{
            "status": "successs",
            "uuid": "ebe5a7ae-803b-427f-bcda-b25bc9bb20a1",
            "result": "Content-Type: api/response\nContent-Length: 25"
    }