---
title: "Create Call by User Phone Number"
method: POST
path: "/calls/identify"
tags: ["Calls"]
---

# Create Call by User Phone Number

`POST /calls/identify`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/calls/identify`
- Auth: API key in header `X-Session-Key`

This endpoint allows you to create a Call based on JSON input, providing as an identifier of the ForceManager User its email instead of the ID. This endpoint is useful in the case in which the external system (e.g. a PBX) is not aware of the ForceManager User ID but it has the reference of all the Users' phone numbers.

You will only be able to create a Call after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |

**REQUEST BODY**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| duration | Integer | Duration of the Call, in seconds |
| startDate | String | Moment in which the Call is started |
| endDate | String | Moment in which the Call is ended |
| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |
| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |
| phone (*Required*) | String | The called phone number |
| accountId (*Required*) | Integer | Account to which the Call is linked to (see [Accounts](#) resource) |
| contactId | Integer | Contact to which the Call is linked to (see [Contacts](#) resource) |
| userPhoneFM (*Required*) | Integer | ForceManager email of the User associated to the Call (see [Users](#) resource) provided as unique identifier in place of the User ID |
| opportunityId | Integer | Opportunity to which the Call is linked to (see [Opportunities](#) resource) |
| phoneAlias | String | An alias of the phone number, e.g. a Contact name |
| description | String | A descriptive text of the Call content |
| timeZoneId | Integer | TimeZone of the Call (see [TimeZones](#) resource) |

**RESPONSE**

Returns a JSON with information about the Call just created.

| **Attribute** | **Type** |
| --- | --- |
| Id | Id assigned to the new Opportunity |
| Message | The operation status |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string

## Request body

- object
  - `startDate` string
  - `endDate` string
  - `type` integer
  - `terminalType` integer
  - `phone` string
  - `accountId` integer
  - `contactId` integer
  - `userPhoneFM` string
  - `opportunityId` integer
  - `phoneAlias` string
  - `timeZoneId` integer

## Response `200`

Create Call by User Phone Number

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)