Skip to main content

Telephone Call Object v2

This guide details the Telephone Call Object v2 API, enabling developers to programmatically manage and access telephone call records

Tom White avatar
Written by Tom White
Updated over 2 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

telephone call ID REQUIRED
integer - ID of your chosen telephone call

Telephone Call Requests

GET POST

Get - Retrieve a telephone call

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/telephone_calls/{id}/

Response

400
​

Returned if the request sent is invalid.

404
​

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "telephone_call_id": 15332,
    "relationship_id": null,
    "contact_id": null,
    "external_reference": null,
    "call_date": "2022-08-05 23:05:00",
    "call_type": null,
    "ring_duration_seconds": 0,
    "call_duration_seconds": 0,
    "hold_duration_seconds": 0,
    "parked_duration_seconds": 0,
    "direction": "O",
    "source_number": "07777777777",
    "destination_number": "08000000000",
    "extension": null,
    "internal_flag": "N",
    "comments": null,
    "recording_url": null,
    "creation_date": "2022-08-16T14:36:22.237Z",
    "last_update_date": "2022-08-16T14:36:22.237Z"
}

post - Insert a new telephone call

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/telephone_calls/

Example Payload Post

{
    "call_date":"08-aug-22 23:05:00",
    "direction":"O",
    "source_number":"07777777777",
    "destination_number":"08000000000",
    "internal_flag":"N"
}

Response

400
​

Returned if the request sent is invalid.

404
​

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "telephone_call_id": 15333,
    "relationship_id": null,
    "contact_id": null,
    "external_reference": null,
    "call_date": "2022-08-08 23:05:00",
    "call_type": null,
    "ring_duration_seconds": 0,
    "call_duration_seconds": 0,
    "hold_duration_seconds": 0,
    "parked_duration_seconds": 0,
    "direction": "O",
    "source_number": "07777777777",
    "destination_number": "08000000000",
    "extension": null,
    "internal_flag": "N",
    "comments": null,
    "recording_url": null,
    "creation_date": "2022-08-16T14:50:44.373Z",
    "last_update_date": "2022-08-16T14:50:44.373Z"
}

Telephone Call Attributes

When adding a new telephone call via the API, there are a number of fields needed.

Mandatory Fields

Expand to view the mandatory fields

call_date - dateTime

direction - string
Must be I (inbound) or O (outbound)

source_number - string

destination_number - string

internal_flag - string
Must be Y or N

Non Mandatory Fields

Expand to view all non- mandatory fields that can be used.

telephone_call_id - number
Must not be supplied when using post or put .

relationship_id - number
Must not be supplied when using post or put .

contact_id - string
Must not be supplied when using post or put .

external_reference - string
If supplied, this must be unique.

ring_duration_seconds - number
Defaults to 0

call_duration_seconds - number
Defaults to 0

hold_duration_seconds - number
Defaults to 0

parked_duration_seconds - number
Defaults to 0

extension - string

comments - string

recording_url - string

Related Articles
Opportunity Object v2
Address Object v2
Driver Object v2
Relationship Note Object v2
Test Drive Object v2
Did this answer your question?