Skip to content

API referenceEndpoints

Calls

Calls the receptionist answered or made, with summaries and transcripts.

On this page

List calls

GET/v1/calls

Scopecalls:read

Newest first.

Partner keys send the client's account id in AssistCall-Account.

Query parameters

  • limitinteger

    How many items to return, 1 to 100.

    Default 251 to 100

  • cursorstring

    The next_cursor of the previous page.

    Up to 300 characters

  • started_afterstring (date-time)

    Only calls that started at or after this time (ISO 8601 with an offset).

  • started_beforestring (date-time)

    Only calls that started before this time.

  • receptionist_idstring (uuid)

    Only calls this receptionist answered.

  • customer_numberstring

    Only calls with this caller (E.164, e.g. +12125550147; US numbers can be written without +1).

    Up to 40 characters

Headers

  • AssistCall-Accountstring (uuid)

    Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.

Responses

  • 200A page of calls.
    • dataarray of CallRequired

      This page of results.

      Call fields
      • idstring (uuid)Required

        Call id.

      • directionstringRequired

        inbound or outbound.

      • statusstringRequired

        The voice platform's status, e.g. ended or in-progress.

      • customer_numberstring or nullRequired

        The caller's number (E.164).

      • receptionist_numberstring or nullRequired

        The account's number on the call.

      • receptionistobject or any or nullRequired

        The receptionist that answered.

      • contactobject or any or nullRequired

        The caller's contact, if they have one.

      • started_atstring (date-time) or nullRequired

        When the call started.

      • ended_atstring (date-time) or nullRequired

        When it ended.

      • duration_secondsintegerRequired

        Length in seconds.

      • ended_reasonstringRequired

        Why it ended, e.g. customer-ended-call.

      • summarystringRequired

        A short summary of the call.

      • categorystring or nullRequired

        What the call was about, e.g. appointment, quote_request, question, emergency.

      • interest_scoreinteger or nullRequired

        How likely the caller is to buy, 0 to 100.

      • sentimentstring or nullRequired

        The caller's mood.

      • urgencystring or nullRequired

        How urgent it was.

      • intentstring or nullRequired

        What the caller wanted.

      • next_stepstring or nullRequired

        The suggested follow-up.

      • has_recordingbooleanRequired

        Whether a recording exists (listen in the portal).

      • created_atstring (date-time)Required

        When the call was logged.

    • has_morebooleanRequired

      Whether there are more results after this page.

    • next_cursorstring or nullRequired

      Pass as cursor to get the next page; null on the last page.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

Example request

curl https://api.assistcall.ai/v1/calls \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "data": [
    {
      "id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
      "direction": "inbound",
      "status": "ended",
      "customer_number": "+12125550147",
      "receptionist_number": "+12125550101",
      "receptionist": {
        "id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
        "name": "Mia"
      },
      "contact": {
        "id": "e5c9a3f7-2d4b-4c6e-8f0a-3b5d7f9c1e57",
        "name": "Maria Lopez"
      },
      "started_at": "2026-10-25T13:29:12.000Z",
      "ended_at": "2026-10-25T13:32:16.000Z",
      "duration_seconds": 184,
      "ended_reason": "customer-ended-call",
      "summary": "Maria Lopez, a new patient, booked a cleaning and exam for Thursday at 10:00 AM.",
      "category": "appointment",
      "interest_score": 86,
      "sentiment": "positive",
      "urgency": "normal",
      "intent": "book_appointment",
      "next_step": "Confirm insurance before the visit.",
      "has_recording": true,
      "created_at": "2026-10-25T13:29:12.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "WyIyMDI2LTEwLTI1VDEzOjI5OjEyLjAwMDAwMFoiLCIzYTdlOWMxNS02ZDJiLTRmNDAtOGUxYS01YjljN2QzZTFmMjQiXQ"
}

Get a call

GET/v1/calls/{id}

Scopecalls:read

Partner keys send the client's account id in AssistCall-Account.

Path parameters

  • idstring (uuid)Required

    The call's id.

Headers

  • AssistCall-Accountstring (uuid)

    Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.

Responses

  • 200The call.
    • idstring (uuid)Required

      Call id.

    • directionstringRequired

      inbound or outbound.

    • statusstringRequired

      The voice platform's status, e.g. ended or in-progress.

    • customer_numberstring or nullRequired

      The caller's number (E.164).

    • receptionist_numberstring or nullRequired

      The account's number on the call.

    • receptionistobject or any or nullRequired

      The receptionist that answered.

    • contactobject or any or nullRequired

      The caller's contact, if they have one.

    • started_atstring (date-time) or nullRequired

      When the call started.

    • ended_atstring (date-time) or nullRequired

      When it ended.

    • duration_secondsintegerRequired

      Length in seconds.

    • ended_reasonstringRequired

      Why it ended, e.g. customer-ended-call.

    • summarystringRequired

      A short summary of the call.

    • categorystring or nullRequired

      What the call was about, e.g. appointment, quote_request, question, emergency.

    • interest_scoreinteger or nullRequired

      How likely the caller is to buy, 0 to 100.

    • sentimentstring or nullRequired

      The caller's mood.

    • urgencystring or nullRequired

      How urgent it was.

    • intentstring or nullRequired

      What the caller wanted.

    • next_stepstring or nullRequired

      The suggested follow-up.

    • has_recordingbooleanRequired

      Whether a recording exists (listen in the portal).

    • created_atstring (date-time)Required

      When the call was logged.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

Example request

curl https://api.assistcall.ai/v1/calls/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
  "direction": "inbound",
  "status": "ended",
  "customer_number": "+12125550147",
  "receptionist_number": "+12125550101",
  "receptionist": {
    "id": "d4b8f2a6-1c3e-4a5b-9d7f-8e6c4a2b0d35",
    "name": "Mia"
  },
  "contact": {
    "id": "e5c9a3f7-2d4b-4c6e-8f0a-3b5d7f9c1e57",
    "name": "Maria Lopez"
  },
  "started_at": "2026-10-25T13:29:12.000Z",
  "ended_at": "2026-10-25T13:32:16.000Z",
  "duration_seconds": 184,
  "ended_reason": "customer-ended-call",
  "summary": "Maria Lopez, a new patient, booked a cleaning and exam for Thursday at 10:00 AM.",
  "category": "appointment",
  "interest_score": 86,
  "sentiment": "positive",
  "urgency": "normal",
  "intent": "book_appointment",
  "next_step": "Confirm insurance before the visit.",
  "has_recording": true,
  "created_at": "2026-10-25T13:29:12.000Z"
}

Get a call's transcript

GET/v1/calls/{id}/transcript

Scopecalls:read

Partner keys send the client's account id in AssistCall-Account.

Path parameters

  • idstring (uuid)Required

    The call's id.

Headers

  • AssistCall-Accountstring (uuid)

    Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.

Responses

  • 200The transcript as text and as turns.
    • call_idstring (uuid)Required

      Call id.

    • textstringRequired

      The whole transcript, one "AI:" or "Caller:" line per turn.

    • turnsarray of objectRequired

      The conversation, in order.

      Fields
      • speakerstringRequired

        Who spoke.

        One of: caller, receptionist

      • textstringRequired

        What they said.

      • seconds_from_startinteger or nullRequired

        When the turn started.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

Example request

curl https://api.assistcall.ai/v1/calls/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e/transcript \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "call_id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
  "text": "AI: Thanks for calling Demo Dental! This is Mia. How can I help you today?\nCaller: Hi, I'd like to book a cleaning.",
  "turns": [
    {
      "speaker": "receptionist",
      "text": "Thanks for calling Demo Dental! This is Mia. How can I help you today?",
      "seconds_from_start": 0
    },
    {
      "speaker": "caller",
      "text": "Hi, I'd like to book a cleaning.",
      "seconds_from_start": 4
    }
  ]
}

Try "token", "webhook signature", "rate limit" or "custom domain".