Calls

Returns a single call by ID. Accepts both integer ID and UUID. Use expand to include related entities or call sub-resources inline.

get/calls/{id}

Request

  • Base URL
    https://api.modjo.ai/v2
  • URL
    https://api.modjo.ai/v2/calls/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Call ID (positive integer) or UUID

Example:1

Query parameters

expandstring

Comma-separated list of relations or call sub-resources to expand. Allowed values: contacts, deal, account, users, libraries, transcript, tags, topics, summaries, notes, next-steps, crm-answers, crm-filling-answers, ai-scoring

Example:contacts,transcript

Response

Call details

idnumber required

Call ID

namestring required

Call title

datestring nullable required

Call date in ISO 8601 format

durationnumber nullable required

Call duration in seconds

directionstring nullable required

Call direction: inbound or outbound

languagestring nullable required

Detected language code (ISO 639-1)

statusstring required

Public status: processing, completed, failed

createdOnstring nullable required

Creation timestamp in ISO 8601 format

modifiedOnstring nullable required

Last modification timestamp in ISO 8601 format

phoneProviderCallIdstring required

External identifier of the call from the phone provider (e.g. Aircall, Ringover, etc.).

recordingRetentionStatus'available' | 'deleted' required

Retention status of the call recording: "available" if the recording is kept, "deleted" if it has been deleted for data retention reasons.

transcriptRetentionStatus'available' | 'deleted' | 'pseudonymised' required

Retention status of the call transcript: "available" if the transcript is kept, "pseudonymised" if identifying information has been removed, "deleted" if it has been deleted for data retention reasons.

contactIdsnumber[]

Contact IDs. Present when contacts are not expanded.

dealIdnumber nullable

Deal ID. Present when deal is not expanded.

accountIdnumber nullable

Account ID. Present when account is not expanded.

userIdsnumber[]

User IDs. Present when users are not expanded.

Example response

{
  "id": 1,
  "name": "Demo call with Acme Corp",
  "date": "2024-06-15T14:30:00.000Z",
  "duration": 1800,
  "direction": "outbound",
  "language": "en",
  "status": "completed",
  "createdOn": "2024-06-15T14:30:00.000Z",
  "modifiedOn": "2024-06-15T15:00:00.000Z",
  "phoneProviderCallId": "aircall-1234567890",
  "recordingRetentionStatus": "available",
  "transcriptRetentionStatus": "available",
  "contacts": [
    {
      "id": 10,
      "name": "John Smith",
      "email": "john@prospect.com",
      "phoneNumber": "+33612345678",
      "jobTitle": "VP of Sales"
    }
  ],
  "deal": {
    "id": 100,
    "name": "Acme Corp - Enterprise Plan",
    "status": "open",
    "stage": "Negotiation",
    "amount": 50000,
    "currency": "EUR",
    "closeDate": "2024-09-30"
  },
  "dealId": 100,
  "account": {
    "id": 200,
    "name": "Acme Corp"
  },
  "accountId": 200,
  "users": [
    {
      "id": 42,
      "email": "jane.doe@company.com",
      "firstName": "Jane",
      "lastName": "Doe"
    }
  ],
  "libraries": [
    {
      "id": 12,
      "name": "Best of calls"
    }
  ],
  "crmActivity": {
    "crmId": "00T1234567ABC",
    "crmOrigin": "created_by_modjo"
  },
  "transcript": [
    {
      "endTime": 12.5,
      "content": "Hi, thanks for joining the call today.",
      "speaker": {
        "id": 1,
        "name": "Jane Doe",
        "type": "user"
      }
    }
  ],
  "tags": [
    {
      "id": 1,
      "name": "Competitor mention",
      "color": "#FF5733"
    }
  ],
  "topics": [
    {
      "id": 1,
      "name": "Pricing discussion",
      "slug": "pricing-discussion",
      "color": "#4287f5",
      "saidBy": "user",
      "startTime": 45.5,
      "endTime": 52.2
    }
  ],
  "summaries": [
    {
      "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "templateTitle": "Meeting Summary",
      "templateLength": "detailed",
      "answer": "The team discussed Q3 targets and agreed to increase outbound outreach by 20%.",
      "language": "en-US",
      "createdOn": "2024-06-15T14:30:00.000Z",
      "modifiedOn": "2024-06-15T15:00:00.000Z"
    }
  ],
  "notes": [
    {
      "id": 1,
      "title": "Follow-up notes",
      "date": "2024-06-15T14:30:00.000Z",
      "status": "PUBLISHED",
      "type": "USER"
    }
  ],
  "nextSteps": [
    {
      "title": "Schedule follow-up meeting",
      "description": "Set up a 30-minute follow-up call with the prospect to review the proposal by end of week."
    }
  ],
  "crmFillingAnswers": [
    {
      "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "callId": 12345,
      "crmFillingFieldUuid": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
      "value": "Follow up next Tuesday",
      "crmId": "006xx000001abc",
      "createdOn": "2024-06-15T14:30:00.000Z",
      "modifiedOn": "2024-06-15T15:00:00.000Z"
    }
  ]
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status