Help Docs

Divert Call

CATEGORY: RINGQ API List

Description:

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

Request URL:

http://<ringq FQDN>:8443/api/values/divertCallByExtension

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

PBX URL:

Action:

Agent Extension:

To Extension:

API Key:

Secret Key:

Sample Curl Request


    curl --location --request POST https://station.ind1.ringq.ai:8443/index/divertCallByExtension  

    -header "Content-Type: application/json" \
    --header "X-API-KEY:" \
    --header "X-SIGNATURE: " \
    --header "X-TIMESTAMP: 1699999999" \
    --header "X-NONCE: abcdef1234" \
    --data-raw 
    {
                        "ringing_extension": "1013",
                        "todivert_extension": "1160",
                        "domain": "station.ind1.ringq.ai"
                    }

Sample PHP Request


            <?php
            

                        $apiKey = "ringq_live_127f4c25daeb";
            $secret = "703311cbeba8a98ed6f08713ceccf62a73fd16a37d3d578e3ce25e2ee0a25ae3";
            $url    = "https://station.ind1.ringq.ai:8443/index/makeCall";

            $body = '{"from":"1013","to":"1016","domain":"station.ind1.ringq.ai"}';


            // =====================================================
            // STEP 1: GET API SERVER TIME FROM DATE HEADER
            // =====================================================
            $ch = curl_init($url);

            curl_setopt_array($ch, [
            CURLOPT_NOBODY => true,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_HEADER => true,
            CURLOPT_SSL_VERIFYPEER => false,
            CURLOPT_SSL_VERIFYHOST => false
            ]);

            $response = curl_exec($ch);
            curl_close($ch);

            // Extract Date header
            preg_match('/^Date:\s*(.+)$/mi', $response, $matches);

            if (!empty($matches[1])) {
                $serverTimestamp = strtotime(trim($matches[1]));
            } else {
                // fallback (should not happen)
                $serverTimestamp = time();
            }

            // Convert to string
            $timestamp = (string)$serverTimestamp;

            // Generate nonce
            $nonce = bin2hex(random_bytes(5)); // 10 char

            // =====================================================
            // STEP 2: CREATE SIGNATURE
            // =====================================================
            $payload   = $apiKey . $timestamp . $nonce . $body;
            $signature = hash_hmac("sha256", $payload, $secret);


            // =====================================================
            // STEP 3: SEND ACTUAL REQUEST
            // =====================================================
            $ch = curl_init();

            curl_setopt_array($ch, [
                CURLOPT_URL => $url,
                CURLOPT_CUSTOMREQUEST => "POST",
                CURLOPT_RETURNTRANSFER => true,
                CURLOPT_POSTFIELDS => $body,
                CURLOPT_HTTPHEADER => [
                    "Content-Type: application/json",
                    "Accept: application/json",
                    "User-Agent: PostmanRuntime/7.32.3",
                    "Connection: close",
                    "Content-Length: " . strlen($body),
                    "X-API-KEY: $apiKey",
                    "X-TIMESTAMP: $timestamp",
                    "X-NONCE: $nonce",
                    "X-SIGNATURE: $signature"
                ],
                CURLOPT_SSL_VERIFYPEER => false,
                CURLOPT_SSL_VERIFYHOST => false,
                CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                CURLOPT_ENCODING => ""
            ]);

            $response = curl_exec($ch);
            $info     = curl_getinfo($ch);
            $error    = curl_error($ch);

            curl_close($ch);


            // =====================================================
            // DEBUG OUTPUT
            // =====================================================
            echo "Response:$response";

Sample Response

{
            "status": "success",
            "ringing_extension": "1013",
            "diverted_to": "1160",
            "uuid": "4a7b0547-a5b9-45a8-9c72-06548db8f8f3"
    }

Self-Hosted

Hosted by RingQ

On-Premise

Integrations

Business Needs

Rich Feature Set

Become a Partner

Channel Partner

Intergration Partner

Carrier Partner

For Partners

Single-Tenant

Multi-Tenant

News

About

Careers

Contact

Our People

Help Docs

Generate API

Sample Curl Request

Sample PHP Request

RingQ Cloud CX

Solutions

Call Center

Call Handling

VoIP FAQ

About RingQ