POST
/
v1
/
calls
Create Phone Call
curl --request POST \
  --url https://api.sigmamind.ai/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "fromPhoneNumber": 14155552671,
  "toPhoneNumber": 14155552671,
  "agentId": "D5D0p7TUs66TTAEAx",
  "variables": {
    "customer_name": "Michael"
  }
}'
{
  "callId": "AuUKK371Spr5nHJS",
  "callType": "inbound",
  "conversationId": 123456789,
  "phoneNumber": "Object",
  "campaign": {
    "campaignId": "XiQEBcj9cc5TFRB4",
    "campaignName": "My Campaign",
    "campaignStatus": "live",
    "scheduledDate": "2023-11-07T05:31:56Z",
    "concurrentCalls": 5,
    "agent": {
      "name": "New AI Agent",
      "agentId": "D5D0p7TUs66TTAEAx",
      "status": "active"
    },
    "phoneNumber": "Object",
    "errors": [
      "<string>"
    ],
    "scheduled": true
  },
  "status": "completed",
  "startTime": "2021-04-20T10:00:00.000Z",
  "endTime": "2021-04-20T10:00:00.000Z",
  "duration": 120,
  "terminationReason": "inactive",
  "createdAt": "2021-04-20T10:00:00.000Z",
  "updatedAt": "2021-04-20T10:00:00.000Z",
  "variables": {
    "customer_name": "Michael"
  }
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Body

application/json
​
fromPhoneNumber
string
required

The caller’s phone number in E.164 format. This number must be obtained from SigmaMind or configured using SIP trunking with SigmaMind.

Example:

14155552671

​
toPhoneNumber
string
required

The callee’s phone number in E.164 format. This defines the recipient of the outbound call.

Example:

14155552671

​
agentId
string

The unique identifier of the Agent assigned to handle the outbound call.

Example:

"D5D0p7TUs66TTAEAx"

​
variables
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }

Response

OK

​
callId
string

A unique identifier for any call, whether inbound, outbound, or web-based.

Example:

"AuUKK371Spr5nHJS"

​
callType
enum<string>

Specifies the direction or type of the call.

Available options:
inbound, outbound, web
Example:

"inbound"

​
conversationId
integer

Unique identifier for the conversation associated with the call.

Example:

123456789

​
phoneNumber
object

Phone number details of the caller

Example:

"Object"

​
campaign
object
​
status
enum<string>

Status of the call

Available options:
scheduled, in-progress, completed, failed
Example:

"completed"

​
startTime
string<date-time>

Timestamp indicating when the call began.

Example:

"2021-04-20T10:00:00.000Z"

​
endTime
string<date-time>

Timestamp indicating when the call ended.

Example:

"2021-04-20T10:00:00.000Z"

​
duration
integer

Total duration of the call in seconds.

Example:

120

​
terminationReason
enum<string>

Reason for call termination

Available options:
customer_ended_call, agent_ended_call, inactivity, busy, no-answer, failed
Example:

"inactive"

​
createdAt
string<date-time>

The timestamp when the call record was created.

Example:

"2021-04-20T10:00:00.000Z"

​
updatedAt
string<date-time>

The timestamp when the call record was last updated.

Example:

"2021-04-20T10:00:00.000Z"

​
variables
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }