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.

JSON format

---

Retrieve All Calls

GET /v2/calls

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

Parameters

Allowed for

• Agents

Using curl

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

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "items": [    {      "data": {        "id": 1,        "user_id": 1,        "summary": "Schedule another call.",        "recording_url": "https://{subdomain}.zendesk.com/sales/apis/voice/api/v1/recordings/15934235/recording.mp3",        "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

POST /v2/calls

Creates a new call.

Parameters

Allowed for

• Agents

Using cURL

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://{subdomain}.zendesk.com/sales/apis/voice/api/v1/recordings/15934235/recording.mp3",    "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"  }}'

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "user_id": 1,    "summary": "Schedule another call.",    "recording_url": "https://{subdomain}.zendesk.com/sales/apis/voice/api/v1/recordings/15934235/recording.mp3",    "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

GET /v2/calls/:id

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

Allowed for

• Agents

Using cURL

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

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "user_id": 1,    "summary": "Schedule another call.",    "recording_url": "https://{subdomain}.zendesk.com/sales/apis/voice/api/v1/recordings/15934235/recording.mp3",    "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

PUT /v2/calls/:id

Updates an existing call. For calls created using Sell Voice, you can only update the following properties:

• summary
• outcome_id
• duration
• phone_number
• incoming
• missed
• made_at
• external_id

Parameters

Allowed for

• Agents

Using curl

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,    "summary": "Schedule another call.",    "outcome_id": 8,    "duration": 115,    "phone_number": "+44-208-1234567",    "incoming": true,    "missed": false,    "made_at": "2016-10-02T11:08:56Z",    "external_id": "a897658e-5e44-4477-9102-d576a2601284"  }}'

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "user_id": 1,    "summary": "Schedule another call.",    "recording_url": "https://{subdomain}.zendesk.com/sales/apis/voice/api/v1/recordings/15934235/recording.mp3",    "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 /v2/calls/:id

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

Parameters

Allowed for

• Agents

Using curl

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

Example Response

HTTP/1.1 204 No Content

Retrieve a Call Recording

GET /v2/calls/:id/recording.mp3

Returns a call recording based on the call id.

Parameters

Allowed for

• Agents

Using curl

curl -v -X GET https://api.getbase.com/v2/calls/140173744/recording.mp3 \-H "Authorization: Bearer ACCESS_TOKEN" \-o "myrecording.mp3"

Example Response

HTTP/2 200content-type: audio/mpeg