Calls

The Calls API provides a simple interface to manage calls.

The API allows you to create, read and delete your calls. You can retrieve individual calls, as well as list of all calls.

Properties

Attribute	Description
id number readonly	Unique identifier of the call.
user_id number	Unique identifier of the user who performed the call.
summary string	Content of the note about this call.
recording_url string	URL pointing to call recording.
outcome_id number	Unique identifier of Call Outcome assigned to the call. See more at Call Outcomes.
duration number	Duration of the call in seconds.
phone_number string	Phone number of the person with which the call was made.
incoming boolean	Indicator of whether the call was incoming or not.
missed boolean	Indicator of whether the call was missed (not answered) by the user or not.
resource_type string	Name of the resource type the call is attached to. If provided, then `resource_id` also has to be provided. Possible values: lead contact
resource_id number	Unique identifier of the resource the call is attached to. If provided, then `resource_type` also has to be provided.
associated_deal_ids array	An array of ids of deals associated to the call.
made_at string	Date and time of when the call was made (started) in UTC (ISO8601 format).
updated_at string readonly	Date and time of the last update in UTC (ISO8601 format).
external_id string	Unique identifier of a call from an external system.

Retrieve all calls

Returns all calls available to the user, according to the parameters provided. Calls are always sorted by made_at in descending order.

Parameters

Attribute	Description
page number optional	Page number to start from. Page numbering starts at 1 and omitting the `page` parameter will return the first page. Maximum page that can be returned is 1000. e.g. `?page=2`
per_page number optional	Number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100. e.g. `?per_page=20`
ids string optional	Comma-separated list of call IDs to be returned in request. e.g. `?ids=1,2,3`
resource_type string optional	Name of the type of resource calls are attached to. Possible values: lead contact e.g. `?resource_type=lead`
resource_id number optional	Unique identifier of the resource calls are attached to. e.g. `?resource_id=7`
associated_deal_id number optional	Unique identifier of the Deal the calls are attached to. e.g. `?associated_deal_id=12`

Action

GET /v2/calls

Examples

Retrieve all calls

GET /v2/calls HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/calls \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/calls", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/calls',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "items": [
    {
      "data": {
        "id": 1,
        "user_id": 1,
        "summary": "Schedule another call.",
        "recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
        "outcome_id": 8,
        "duration": 115,
        "phone_number": "+44-208-1234567",
        "incoming": true,
        "missed": false,
        "resource_type": "contact",
        "resource_id": 7,
        "associated_deal_ids": [
          12
        ],
        "made_at": "2016-10-02T11:08:56Z",
        "updated_at": "2016-10-03T16:32:56Z",
        "external_id": "a897658e-5e44-4477-9102-d576a2601284"
      },
      "meta": {
        "type": "call"
      }
    }
  ],
  "meta": {
    "type": "collection",
    "count": 1,
    "links": {
      "self": "http://api.getbase.com/v2/calls.json"
    }
  }
}

Create a call

Creates a new call.

Parameters

Attribute	Description
user_id number optional	Unique identifier of the user who performed the call. Defaults to the unique identifier of the user who created the call. e.g. `"user_id": "1"`
summary string optional	Content of the note about this call. e.g. `"summary": "Highly important."`
recording_url string optional	URL pointing to call recording. e.g. `"recording_url": "http://example.com/recording.mp3"`
outcome_id number optional	Unique identifier of Call Outcome assigned to the call. See more at Call Outcomes. e.g. `"outcome_id": "8"`
duration number optional	Duration of the call in seconds. e.g. `"duration": "120"`
phone_number string required	Phone number of the person with which the call was made. e.g. `"phone_number": "+44-208-1234567"`
incoming boolean optional	Indicator of whether the call was incoming or not. e.g. `"incoming": "true"`
missed boolean optional	Indicator of whether the call was missed (not answered) by the user or not. e.g. `"missed": "false"`
resource_type string optional	Name of the resource type the call is attached to. If not null, then resource_id also has to be not null. Possible values: lead contact e.g. `"resource_type": "lead"`
resource_id number optional	Unique identifier of the resource the call is attached to. If not null, then resource_type also has to be not null. e.g. `"resource_id": "7"`
associated_deal_ids array optional	An array of ids of deals associated to the call. e.g. `"associated_deal_ids": [10, 11]`
made_at string optional	Date and time of when the call was made (started) in UTC (ISO8601 format). Defaults to current time. e.g. `"made_at": "2016-10-28T12:12:05Z"`
external_id string optional	Unique identifier of a call from an external system. Defaults to null.

Action

POST /v2/calls

Examples

Simple create

POST /v2/calls HTTP/1.1

Accept: application/json
Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
  "data": {
    "user_id": 1,
    "summary": "Schedule another call.",
    "recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
    "outcome_id": 8,
    "duration": 115,
    "phone_number": "+44-208-1234567",
    "incoming": true,
    "missed": false,
    "resource_type": "contact",
    "resource_id": 7,
    "associated_deal_ids": [
      12
    ],
    "made_at": "2016-10-02T11:08:56Z",
    "external_id": "a897658e-5e44-4477-9102-d576a2601284"
  }
}

curl -v -X POST https://api.getbase.com/v2/calls \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
  "data": {
    "user_id": 1,
    "summary": "Schedule another call.",
    "recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
    "outcome_id": 8,
    "duration": 115,
    "phone_number": "+44-208-1234567",
    "incoming": true,
    "missed": false,
    "resource_type": "contact",
    "resource_id": 7,
    "associated_deal_ids": [
      12
    ],
    "made_at": "2016-10-02T11:08:56Z",
    "external_id": "a897658e-5e44-4477-9102-d576a2601284"
  }
}'

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
body = '{
"data": {
"user_id": 1,
"summary": "Schedule another call.",
"recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
"outcome_id": 8,
"duration": 115,
"phone_number": "+44-208-1234567",
"incoming": true,
"missed": false,
"resource_type": "contact",
"resource_id": 7,
"associated_deal_ids": [12],    
"made_at": "2016-10-02T11:08:56Z",
"external_id": "a897658e-5e44-4477-9102-d576a2601284"
}
}
'
response = RestClient.execute method: :post, url: "https://api.getbase.com/v2/calls", payload: body, headers: headers

puts response

import requests
import json

payload = {
  'data': {
    'user_id': 1,
    'summary': 'Schedule another call.',
    'recording_url': 'https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda',
    'outcome_id': 8,
    'duration': 115,
    'phone_number': '+44-208-1234567',
    'incoming': true,
    'missed': false,
    'resource_type': 'contact',
    'resource_id': 7,
    'associated_deal_ids': [
      12
    ],
    'made_at': '2016-10-02T11:08:56Z',
    'external_id': 'a897658e-5e44-4477-9102-d576a2601284'
  }
}

response = requests.post(
    url='https://api.getbase.com/v2/calls',
    headers={
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    data=json.dumps(payload),
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 1,
    "user_id": 1,
    "summary": "Schedule another call.",
    "recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
    "outcome_id": 8,
    "duration": 115,
    "phone_number": "+44-208-1234567",
    "incoming": true,
    "missed": false,
    "resource_type": "contact",
    "resource_id": 7,
    "associated_deal_ids": [
      12
    ],
    "made_at": "2016-10-02T11:08:56Z",
    "updated_at": "2016-10-03T16:32:56Z",
    "external_id": "a897658e-5e44-4477-9102-d576a2601284"
  },
  "meta": {
    "type": "call"
  }
}

Retrieve a single call

Returns a single call available to the user, according to the unique call ID provided. If the specified call does not exist, this query returns an error.

Parameters

Attribute	Description
id number required	Unique identifier of the call.

Action

GET /v2/calls/:id

Examples

Retrieve a call with id 1

GET /v2/calls/1 HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/calls/1 \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/calls/1", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/calls/1',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 1,
    "user_id": 1,
    "summary": "Schedule another call.",
    "recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
    "outcome_id": 8,
    "duration": 115,
    "phone_number": "+44-208-1234567",
    "incoming": true,
    "missed": false,
    "resource_type": "contact",
    "resource_id": 7,
    "associated_deal_ids": [
      12
    ],
    "made_at": "2016-10-02T11:08:56Z",
    "updated_at": "2016-10-03T16:32:56Z",
    "external_id": "a897658e-5e44-4477-9102-d576a2601284"
  },
  "meta": {
    "type": "call"
  }
}

Update a call

The update API allows to attach a Contact or Lead to an existing Call, or change it’s current association.

Parameters

Attribute	Description
resource_type string optional	Name of the resource type the call is going to be attached to. If not null, then resource_id also has to be not null. Possible values: lead contact e.g. `"resource_type": "lead"`
resource_id number optional	Unique identifier of the resource the call is going to be attached to. If not null, then resource_type also has to be not null. e.g. `"resource_id": "7"`
recording_url string optional	URL pointing to call recording. e.g. `"recording_url": "http://example.com/recording.mp3"`

Action

PUT /v2/calls/:id

Examples

Update a Call with ID 1

PUT /v2/calls/1 HTTP/1.1

Accept: application/json
Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
  "data": {
    "resource_type": "contact",
    "resource_id": 12345
  }
}

curl -v -X PUT https://api.getbase.com/v2/calls/1 \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
  "data": {
    "resource_type": "contact",
    "resource_id": 12345
  }
}'

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
body = '{
  "data": {
    "resource_type": "contact",
    "resource_id": 12345
  }
}

'
response = RestClient.execute method: :put, url: "https://api.getbase.com/v2/calls/1", payload: body, headers: headers

puts response

import requests
import json

payload = {
  'data': {
    'resource_type': 'contact',
    'resource_id': 12345
  }
}

response = requests.put(
    url='https://api.getbase.com/v2/calls/1',
    headers={
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    data=json.dumps(payload),
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 1,
    "user_id": 1,
    "summary": "Schedule another call.",
    "recording_url": "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda",
    "outcome_id": 8,
    "duration": 115,
    "phone_number": "+44-208-1234567",
    "incoming": true,
    "missed": false,
    "resource_type": "contact",
    "resource_id": 12345,
    "associated_deal_ids": [
      12
    ],
    "made_at": "2016-10-02T11:08:56Z",
    "updated_at": "2016-10-03T16:32:56Z"
  },
  "meta": {
    "type": "call"
  }
}

Delete a call

Delete an existing call. If the specified call does not exist, this query returns an error. This operation cannot be undone.

Parameters

Attribute	Description
id number required	Unique identifier of the call.

Action

DELETE /v2/calls/:id

Examples

Delete a call with id 1

DELETE /v2/calls/1 HTTP/1.1

Authorization: Bearer $ACCESS_TOKEN

curl -v -X DELETE https://api.getbase.com/v2/calls/1 \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
response = RestClient.execute method: :delete, url: "https://api.getbase.com/v2/calls/1"

puts response

import requests
import json

response = requests.delete(
    url='https://api.getbase.com/v2/calls/1',
    headers={
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 204 No Content

Calls

Properties

Possible values:

Endpoints

Retrieve all calls

Parameters

Possible values:

Create a call

Parameters

Possible values:

Retrieve a single call

Parameters

Update a call

Parameters

Possible values:

Delete a call

Parameters