Skip to content

API referenceEndpoints

Messages

Messages the receptionist took for the team.

On this page

List messages

GET/v1/messages

Scopemessages:read

Messages the receptionist took for the team, 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

  • statusstring

    Open, resolved, or all.

    One of: open, resolved, allDefault all

  • call_idstring (uuid)

    Only messages from this call.

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 messages.
    • dataarray of MessageRequired

      This page of results.

      Message fields
      • idstring (uuid)Required

        Message id.

      • call_idstring (uuid) or nullRequired

        The call it was taken on.

      • contact_idstring (uuid) or nullRequired

        The caller's contact.

      • caller_namestringRequired

        The caller's name.

      • caller_phonestringRequired

        The caller's number.

      • bodystringRequired

        The message.

      • urgencystringRequired

        normal or urgent.

      • resolvedbooleanRequired

        Whether someone dealt with it.

      • resolved_atstring (date-time) or nullRequired

        When it was resolved.

      • created_atstring (date-time)Required

        When it was taken.

    • 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/messages \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "data": [
    {
      "id": "b2f6d0a4-8e1c-4a3b-9c5d-6e8f0a2c4b68",
      "call_id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
      "contact_id": "e5c9a3f7-2d4b-4c6e-8f0a-3b5d7f9c1e57",
      "caller_name": "James Carter",
      "caller_phone": "+17185550133",
      "body": "Cracked tooth, pain when chewing. Wants an emergency visit as soon as possible.",
      "urgency": "urgent",
      "resolved": false,
      "resolved_at": null,
      "created_at": "2026-10-25T13:32:16.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Get a message

GET/v1/messages/{id}

Scopemessages:read

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

Path parameters

  • idstring (uuid)Required

    The message'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 message.
    • idstring (uuid)Required

      Message id.

    • call_idstring (uuid) or nullRequired

      The call it was taken on.

    • contact_idstring (uuid) or nullRequired

      The caller's contact.

    • caller_namestringRequired

      The caller's name.

    • caller_phonestringRequired

      The caller's number.

    • bodystringRequired

      The message.

    • urgencystringRequired

      normal or urgent.

    • resolvedbooleanRequired

      Whether someone dealt with it.

    • resolved_atstring (date-time) or nullRequired

      When it was resolved.

    • created_atstring (date-time)Required

      When it was taken.

    • 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/messages/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "id": "b2f6d0a4-8e1c-4a3b-9c5d-6e8f0a2c4b68",
  "call_id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
  "contact_id": "e5c9a3f7-2d4b-4c6e-8f0a-3b5d7f9c1e57",
  "caller_name": "James Carter",
  "caller_phone": "+17185550133",
  "body": "Cracked tooth, pain when chewing. Wants an emergency visit as soon as possible.",
  "urgency": "urgent",
  "resolved": false,
  "resolved_at": null,
  "created_at": "2026-10-25T13:32:16.000Z"
}

Resolve or reopen a message

PATCH/v1/messages/{id}

Scopemessages:write

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

Sandbox keys get 403 sandbox_read_only.

Path parameters

  • idstring (uuid)Required

    The message'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.

Request body

  • resolvedbooleanRequired

    true to resolve, false to open it again.

Responses

  • 200The message.
    • idstring (uuid)Required

      Message id.

    • call_idstring (uuid) or nullRequired

      The call it was taken on.

    • contact_idstring (uuid) or nullRequired

      The caller's contact.

    • caller_namestringRequired

      The caller's name.

    • caller_phonestringRequired

      The caller's number.

    • bodystringRequired

      The message.

    • urgencystringRequired

      normal or urgent.

    • resolvedbooleanRequired

      Whether someone dealt with it.

    • resolved_atstring (date-time) or nullRequired

      When it was resolved.

    • created_atstring (date-time)Required

      When it was taken.

    • 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 -X PATCH https://api.assistcall.ai/v1/messages/7d3c5a2e-9b1f-4c6a-8e2d-1f0a9b8c7d6e \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "resolved": true
}'

Example response (200)

{
  "id": "b2f6d0a4-8e1c-4a3b-9c5d-6e8f0a2c4b68",
  "call_id": "3a7e9c15-6d2b-4f40-8e1a-5b9c7d3e1f24",
  "contact_id": "e5c9a3f7-2d4b-4c6e-8f0a-3b5d7f9c1e57",
  "caller_name": "James Carter",
  "caller_phone": "+17185550133",
  "body": "Cracked tooth, pain when chewing. Wants an emergency visit as soon as possible.",
  "urgency": "urgent",
  "resolved": true,
  "resolved_at": "2026-10-25T15:04:05.000Z",
  "created_at": "2026-10-25T13:32:16.000Z"
}

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