Go to App

Calls

Operations related to calls

Get all Calls

get

Returns a list of calls with pagination support.

Autorizaciones
Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

namestringOpcional

Call name to filter calls by (partial match).

Respuestas
200Éxito
application/json
get
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": "+1234567890",
    "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.

Autorizaciones
Cuerpo
namestringRequerido

Name of the call for uploading

Example: Sales Call Recording
mediaUrlstringOpcional

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

Example: https://example.com/upload/call_recording.mp3
startDateTimestring · date-timeRequerido

Scheduled start date and time of the call

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

Description of the call

Example: Recording of the sales call with Acme Corp.
fromNumberstringOpcional

Phone number of the caller

Example: +1234567890
toNumberstringOpcional

Phone number of the callee

Example: +0987654321
filestring · binaryOpcional

Audio file to upload (alternative to mediaUrl)

Respuestas
201Éxito
application/json
post
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: 261

{
  "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": "+1234567890",
  "toNumber": "+0987654321",
  "file": "binary"
}
{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "callId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}

Get Call by ID

get

Get a call by ID.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to retrieve.

Respuestas
200Éxito
application/json
get
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": "+1234567890",
    "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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to delete.

Respuestas
200Éxito
application/json
delete
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get participants from.

Respuestas
200Éxito
application/json
get
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": "+1234567890",
        "isHost": true,
        "isInternal": false
      }
    ]
  }
}

Get Call Summary

get

Returns a summary for a given call ID.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get summary from.

Respuestas
200Éxito
application/json
get
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get transcript from.

Respuestas
200Éxito
application/json
get
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get notes from.

Respuestas
200Éxito
application/json
get
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get chat from.

Respuestas
200Éxito
application/json
get
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get contacts from.

Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

Respuestas
200Éxito
application/json
get
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get companies from.

Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

Respuestas
200Éxito
application/json
get
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.

Autorizaciones
Parámetros de ruta
idstringRequerido

Call ID to get opportunities from.

Parámetros de consulta
pagenumberOpcional

Page number to retrieve.

limitnumberOpcional

Number of items per page.

Respuestas
200Éxito
application/json
get
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"
  }
}
AnteriorCalendar EventsSiguienteCall Notes