Click2Call

Initiates a Click2Call: we first ring the agent (leg A), and once the agent answers we place the call to the destination (leg B) and bridge the two legs together. This lets an agent start an outbound call straight from a third party application such as a CRM.

Parameters. All four values are passed in the path:

• c2c_id (string): The unique identifier for your Click2Call setup. The request is authorized by this identifier together with the caller's IP address against the setup's allowed IP list.
• leg_a (string): The agent extension that is rung first (the caller).
• leg_b (string): The destination phone number that is dialed after the agent answers (the callee).
• route_number (string): The outbound prefix applied to the call, default 00. It must match a prefix configured on the dial pattern of your Manual Dialing Routes.

Any additional query parameters beyond the path values are captured as call metadata. Up to 20 extra parameters are stored, and each value is truncated to 4096 characters.

Returns. On success (HTTP 201) a JSON object with the call identifiers and a status message:

{
  "call_id": "47049",
  "call_uuid": "1abee675-0110-4970-aa41-34c1e4f98933",
  "message": "Leg A answered"
}

Errors.

• 401: A required path parameter is missing.
• 403: The caller's IP address is not allowed for this setup.
• 404: The Click2Call setup was not found or is disabled.
• 501: The call could not be completed, for example the agent did not answer, the agent extension was not found, the destination reached its maximum attempts, or no outbound route matched.

Example. GET /call/{c2c_id}/{leg_a}/{leg_b}/{route_number}