Calls

Operations related to calls

Get all Calls

get

Returns a list of calls with pagination support.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

namestringOptional

Call name to filter calls by (partial match).

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls

HTTPcURLJavaScriptPython

GET /api/v1/calls HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "status": "completed",
    "name": "Sales Call with Acme Corp",
    "startDateTime": "2024-07-15T10:00:00.000Z",
    "endDateTime": "2024-07-15T11:00:00.000Z",
    "duration": 3600,
    "description": "Discussion about new product features",
    "language": "en",
    "direction": "OUTBOUND",
    "fromNumber": "[phone]",
    "toNumber": "+0987654321",
    "callType": {
      "id": "type123",
      "name": "Sales Call"
    },
    "aiScore": 0.95,
    "url": "https://app.salescaling.com/calls/5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Upload Call

post

Uploads a call. You can either provide a mediaUrl in the body or upload a file directly.

Authorizations

x-api-key

x-api-keystringRequired

Body

multipart/form-data

namestringRequired

Name of the call for uploading

Example: Sales Call Recording

mediaUrlstringOptional

URL of the media file to upload (alternative to file upload)

Example: https://example.com/upload/call_recording.mp3

startDateTimestring · date-timeRequired

Scheduled start date and time of the call

Example: 2024-07-18T14:00:00.000Z

descriptionstringOptional

Description of the call

Example: Recording of the sales call with Acme Corp.

fromNumberstringOptional

Phone number of the caller

Example: [phone]

toNumberstringOptional

Phone number of the callee

Example: +0987654321

filestring · binaryOptional

Audio file to upload (alternative to mediaUrl). It must be a valid mp3 / wav file

ownerIdstringOptional

ID of the user who owns this call

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

personIdsstring[]Optional

Array of person IDs for this call participants. Use comma to separate the values

Example: ["5516cd47-2bd0-4f4f-adc2-22524e54ba4d"]

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/calls/upload

HTTPcURLJavaScriptPython

POST /api/v1/calls/upload HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 363

{
  "name": "Sales Call Recording",
  "mediaUrl": "https://example.com/upload/call_recording.mp3",
  "startDateTime": "2024-07-18T14:00:00.000Z",
  "description": "Recording of the sales call with Acme Corp.",
  "fromNumber": "[phone]",
  "toNumber": "+0987654321",
  "file": "binary",
  "ownerId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
  "personIds": [
    "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  ]
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Get Call by ID

get

Get a call by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to retrieve.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "status": "completed",
    "name": "Sales Call with Acme Corp",
    "startDateTime": "2024-07-15T10:00:00.000Z",
    "endDateTime": "2024-07-15T11:00:00.000Z",
    "duration": 3600,
    "description": "Discussion about new product features",
    "language": "en",
    "direction": "OUTBOUND",
    "fromNumber": "[phone]",
    "toNumber": "+0987654321",
    "callType": {
      "id": "type123",
      "name": "Sales Call"
    },
    "aiScore": 0.95,
    "url": "https://app.salescaling.com/calls/5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Delete Call

delete

Deletes a call by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to delete.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/calls/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/calls/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Get Call Participants

get

Returns a list of participants for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get participants from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/participants

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/participants HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "participants": [
      {
        "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
        "name": "John Doe",
        "phone": "[phone]",
        "isHost": true,
        "isInternal": false
      }
    ]
  }
}

Get Call Summary

get

Returns a summary for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get summary from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/summary

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/summary HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "summary": "The call was productive, and we finalized the project timeline.",
    "nextSteps": [
      {
        "action": "Send follow-up email",
        "actors": [
          "John Doe",
          "Team Leads"
        ],
        "deadline": "2024-07-20"
      }
    ],
    "aiOpinion": "Positive sentiment detected overall.",
    "insights": {
      "intro": "Introduction to the project",
      "questions": [
        {
          "question": "What is the timeline?",
          "answer": "We aim to complete in 3 months"
        }
      ],
      "objections": {
        "summary": "Some concerns about pricing",
        "objections": [
          {
            "objection": "Price is too high",
            "answer": "We can offer a discount"
          }
        ]
      },
      "closing": {
        "summary": "Agreed to follow up next week",
        "closing": [
          {
            "statement": "Let's schedule a follow-up",
            "doneBy": "John Doe"
          }
        ]
      }
    }
  }
}

Get Call Transcript

get

Returns a transcript for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get transcript from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/transcript

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/transcript HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "transcript": [
      {
        "startTime": 10,
        "endTime": 25,
        "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
        "participantName": "John Doe",
        "content": "John Doe said something important."
      }
    ]
  }
}

Get Call Notes

get

Returns a list of notes for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get notes from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/notes

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/notes HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "notes": [
      {
        "content": "Customer interested in premium features",
        "smartCategory": {
          "id": "cat123",
          "name": "Customer Interest"
        }
      }
    ]
  }
}

Get Call Chat

get

Returns a chat for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get chat from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/chat

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/chat HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "messages": [
      {
        "question": "What time does the call start?",
        "answer": "The call starts at 10:00 AM"
      }
    ]
  }
}

Get Call Contacts

get

Returns a list of contacts for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get contacts from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/contacts

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/contacts HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "contactId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Get Call Companies

get

Returns a list of companies for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get companies from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/companies

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/companies HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "companyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Get Call Opportunities

get

Returns a list of opportunities for a given call ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Call ID to get opportunities from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/calls/{id}/opportunities

HTTPcURLJavaScriptPython

GET /api/v1/calls/{id}/opportunities HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "opportunityId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}