---
title: "startcall"
slug: "startcall"
updated: 2024-10-25T11:02:05Z
published: 2024-10-25T11:02:05Z
canonical: "docs.voiso.com/startcall"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voiso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# startcall

Post/api/v1/{api_key}/click2call

Enables agents to initiate a call from a third-party application, such as a CRM, via the API. Agents are identified by their extensions in the <tt>agent</tt> parameter. The <tt>number</tt> parameter specifies the destination numbers.

Path parametersapi_keystringRequired

The [Contact Center API key](https://developers.voiso.com/client/#/rest/getting-started/authentication/how-to-obtain-the-contact-center-key).

Example{contact_center_api_key}

Query parametersagentstringRequired

The extension of the Agent making the call.

Example347
numberstringRequired

The outbound number to dial in E.164 format.

Example16461572020
account_idstring

An ID for the contact. Used to mask the phone number in the softphone.

Example12345678
crmstring

The name of a CRM or other service used to add a tag to the call.

Examplemy_crm
get_call_idboolean

Set to true to get the <tt>call_id<tt> (the UUID assigned to the call in the CDR) as a json in the response.</tt></tt>

Responses200

All parameters are valid and the API call is successful.

<select class='api-response-data' aria-label='Media type'><option value='40a6a293-8c6f-430b-b5b3-f7ae604b62f5'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='42055455-5e5c-4255-9dc7-6de40aebd48c'>example1</option>
</select>example1

Calls 1

Call records array requested with page based pagination.

```json
{
  "call_id": "24f6a191-f0ad-4257-x934-32xx26x51208"
}
```

Example{
  "call_id": "24f6a191-f0ad-4257-x934-32xx26x51208"
}

204

All parameters are valid and the API call is successful. No content in response.

400

Incorrect body parameters

<select class='api-response-data' aria-label='Media type'><option value='6bb10719-7bef-4b7b-a17c-d7bb2c97d282'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='88af35ba-d520-44c6-983a-037986b299cd'>example1</option>
<option value='3415f581-b3ee-4237-a989-ac018c1f9d8d'>example2</option>
<option value='fe74097e-adaf-4478-8aa1-f14792feb294'>example3</option>
<option value='b67e759a-cc30-48a5-a979-fa9afe63a30e'>example4</option>
</select>example1

Error1

Agent click2call disabled

```json
{
  "error": "Click2call is disabled in the agent's security access group."
}
```

example2

Error2

Invalid destination number. Number must be in E.164 format.

```json
{
  "error": "Invalid destination number"
}
```

example3

Error3

The agent's extension is not in the correct format or the extension is not assigned.

```json
{
  "error": "Invalid agent's extension"
}
```

example4

Error4

The agent is not logged into their softphone.

```json
{
  "error": "Agent logged off"
}
```

Example{
  "error": "Click2call is disabled in the agent's security access group."
}

403

Invalid api_key

<select class='api-response-data' aria-label='Media type'><option value='8de6e53c-76f9-4b8a-9151-8aec50f6f9f7'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='a71e05a7-9e50-4764-a5ce-e9688a80418e'>example1</option>
</select>example1

Error1

Invalid API key

```json
{
  "error": "Invalid API key"
}
```

Example{
  "error": "Invalid API key"
}