Skip to content

API Reference / Calls

POST /calls

Create a call

Logs a phone call against a contact. contact_id is required; record the outcome with call_result (from the account's configured results), plus the number dialled and an optional recording link.

Maintained by the OnePageCRM engineering team

Request body

  • contact_idstringbson-id

    ID of the contact, to whom the call belongs

  • call_time_intintegerunix-timestamp

    Time the call occurred in UNIX Epoch time in seconds (defaults to current time, if left blank).

  • textstring

    Extra details related to the call (supports `[b]bold[/b]` and `[i]italic[/i]` formatting)

  • phone_numberstring

    Phone number used to make the call

  • call_resultstring

    Key of the `call_result` which best describes the result of the call

  • viastring

    Through which application did the call take place

    enum: unknown · jabber · talkdesk · phone

  • recording_linkstring

    URL of the recording of the call conversation

  • user_ids_to_notifyarray<string>

    A list of user IDs to notify

Responses

201 Created
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • callobject

      Allow you to keep track of phone calls made to your contacts. Calls include information like the phone number dialled and the call result. Calls support file attachments.

      object fields →
      • idstringbson-id

        ID of the call

      • contact_idstringbson-idrequired

        ID of the contact, to whom the call belongs

      • textstring

        Extra details related to the call (supports `[b]bold[/b]` and `[i]italic[/i]` formatting)

      • call_resultstring

        Key of the `call_result` which best describes the result of the call

      • call_time_intintegerunix-timestamp

        Time the call occurred in UNIX Epoch time in seconds (defaults to current time, if left blank).

      • viastring

        Through which application did the call take place

        enum: unknown · jabber · talkdesk · phone

      • phone_numberstring

        Phone number used to make the call

      • recording_linkstring

        URL of the recording of the call conversation

      • authorstring

        Shortened name of the creator of the call. Defaults to the logged API user.

      • attachmentsarray<object>

        Files attached to the call.

        array item fields →
        • idstringbson-id

          ID of the attachment

        • filenamestringrequired

          Name of the attachment file

        • custom_filenamestring

          Custom name of the attachment file

        • pinnedboolean

          Show if the attachment is pinned to its owner contact

        • pinned_atstring

          Shows pinned at timestamp. Is null if pinned == false

        • sizeintegerint32required

          Size of the attachment file (in bytes)

        • storage_providerstring

          Name of the storage provider (where the attachment file is stored)

          enum: amazon · google_drive · dropbox · evernote

        • urlstring

          External URL of the attachment file

        • url_expires_atstringdate-time

          The time the attachment URL expires

        • thumbnailobject

          An image preview of the attachment file (if one exists)

          object fields →
          • urlstring

            External URL of the attachment's thumbnail

      • created_atstringdate-time

        Creation time of the call

      • modified_atstringdate-time

        Last modification time of the call

      • indexintegerint32

        Index of the call (in the results set)

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides