Skip to main content

API documentation for integration with INVOX Call Tracking

Date of last change: 14.03.2024

Written by Iulian de la INVOX
Updated this week

Accepted requests type: GET

Mandatory - requests must contain the X-API-Key header to which a token is sent.

Based on this token, the call tracking account is identified in the database.

We generate the token and send it to you by email only at request.

Accepted parameters are:

  • last_call_id (optional)

  • from_date (optional)

  • to_date (optional)

If no parameter is sent then all calls in the account associated with the token are returned.

The returned result is in JSON format and has the following structure:

  • call_id – the id of the call in the INVOX database

  • date – call date, in the following format 'Y-m-d H:i:s';

  • duration - call duration

  • status – call status; can have one of the values: Answered, No answer, User busy, Call Rejected, Voice Mail, Calling, Unallocated (unassigned) number;

  • caller – the caller's phone number

  • receivingnumber – phone number that was called (INVOX tracking number);

  • destinationnumber – endpoint phone number (INVOX customer number, which receives calls from tracking numbers)

  • source – the marketing channel set in the INVOX dashboard (social, paid search, organic search, newsletter, outdoor, print, etc…)

  • keyword – PPC keyword searched by the user to reach the site

  • referrer – the webpage that send visitor to the site using a link

  • medium – The utm_medium parameter set by the INVOX customer

  • campaign – The utm_campaign parameter set by the INVOX customer

  • page - the last page viewed by the caller before making the call

  • campaignid - ValueTrack parameter

  • adgroupid - ValueTrack parameter

  • network - ValueTrack parameter

  • matchtype - ValueTrack parameter

  • creative - ValueTrack parameter

  • adposition - ValueTrack parameter

  • device - the device from which the caller visited the site (computer, mobile, table)

  • day - day of the call

  • hour - hour of the call

  • recording_uri – url to the player (of call recording) from INVOX platform (if applicable)

  • gclid - Google click ID

  • fbclid - Facebook click ID

  • gacid - Google Analytics client ID

  • ttclid - TikTok click ID

  • reason - a brief description of the reason for the call

  • summary - call summary

  • client_sentiment - customer sentiment during the call: positive, neutral, negative

  • operator_sentiment - operator sentiment during the call: positive, neutral, negative

  • utm_content

  • utm_term

  • utm_source

  • account - account name in the INVOX platform

Did this answer your question?