Make a click-to-dial call

POST/api/v1/domains/{domain_uuid}/click-to-dial

Make a registered phone dial a destination. Use the targets endpoint to find the phone’s agent value. Without a selector, the most recently registered controllable phone group is selected; other matches appear in skipped_targets.

This request can start a call or change a phone’s current call state.

Path parameters

domain_uuidstringrequired

Your company ID supplied by Junction Cloud Connections. Use the same ID throughout your requests.

Request body application/json

extensionstringrequired

Extension number to control.

destinationstringrequired

Destination number or dial string to call.

agentstring

Optional. Preferred selector for a specific phone. Retrieve the agent value from GET /api/v1/domains/{domain_uuid}/phone-control/targets; plain text matching is case-insensitive.

vendorstring

Optional. Broader selector for any matching phone from this vendor. Valid values: poly, polycom, yealink, grandstream, snom, ringotel, or generic.

Responses

200Success

objectstring

domain_uuidstring

extension_uuidstring

extensionstring

destinationstring

sentboolean

targetsarray[object]

Show nested fields

vendorstring

agentstring

skipped_targetsarray

resultsarray[object]

Show nested fields

sentboolean

reasonstring

vendorstring

agentstring

400Validation error

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

403The request is not available for this account.

404Extension not found

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

409No controllable registrations

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

500Internal server error

errorobject

Show nested fields

typestring

messagestring

REQUEST EXAMPLE

Replace the host, token and example IDs with your account details.

curl --request POST \
  --url "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/click-to-dial" \
  --header "Authorization: Bearer $JUNCTIONCC_API_TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "extension": "1001",
  "destination": "18005551212",
  "agent": "SIP-T53W"
}'

const token = process.env.JUNCTIONCC_API_TOKEN;

const response = await fetch("https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/click-to-dial", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    Accept: "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "extension": "1001",
  "destination": "18005551212",
  "agent": "SIP-T53W"
})
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const text = await response.text();
console.log(text ? JSON.parse(text) : null);

import json
import os
from urllib.request import Request, urlopen

request = Request(
    "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/click-to-dial",
    method="POST",
    headers={
        "Authorization": "Bearer " + os.environ["JUNCTIONCC_API_TOKEN"],
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data=json.dumps({'extension': '1001', 'destination': '18005551212', 'agent': 'SIP-T53W'}).encode("utf-8")
)
with urlopen(request, timeout=30) as response:
    body = response.read()
    print(json.loads(body) if body else None)

RESPONSE EXAMPLE

{
  "object": "click_to_dial_call",
  "domain_uuid": "4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b",
  "extension_uuid": "d2c7b17c-8b0d-4f0f-b5ff-2cfb6d7a4f4b",
  "extension": "1001",
  "destination": "18005551212",
  "sent": true,
  "targets": [
    {
      "vendor": "yealink",
      "agent": "Yealink SIP-T53W 96.86.0.45"
    }
  ],
  "skipped_targets": [],
  "results": [
    {
      "sent": true,
      "reason": null,
      "vendor": "yealink",
      "agent": "Yealink SIP-T53W 96.86.0.45"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The destination field is required.",
    "code": "invalid_parameter",
    "param": "destination"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Unauthenticated.",
    "code": "unauthenticated"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Extension not found.",
    "code": "resource_missing",
    "param": "extension"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "No controllable registrations found for 1001@pbx.example.com.",
    "code": "no_controllable_registrations",
    "param": "extension"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "An unexpected error occurred."
  }
}