Call

A log of an inbound or outbound call made with a prospect.

answeredAt
string <date-time>

The date and time the call was answered.

completedAt
string <date-time>

The date and time the call was completed.

createdAt
string <date-time>

The date and time the call record was created in database. This does not necessarily indicate the time the call was made. If you need the time the call was made, please use either dialedAt or answeredAt.

dialedAt
string <date-time>

The date and time the call was dialed.

direction
string

The call direction from the user’s point of view; must be either "inbound" or "outbound".

externalVendor
string <= 255 characters

The voice provider of the call. Can be blank.

from
string <= 255 characters

The phone number used to place the call.

note
string <= 65535 characters

A custom note associated with this call.

outcome
string <= 255 characters

The call’s outcome; must be either "Answered" or "Not Answered".

recordingUrl
string <= 255 characters

The URL of the call's audio recording. This field only accepts HTTP and HTTPS values.

returnedAt
string <date-time>

The date and time the call was returned.

sequenceAction
string <= 255 characters

The action to take on the associated sequence; must be either "Advance", "Finish", "Finish - No Reply", or "Finish - Replied".

shouldRecordCall
boolean

Indicated whether or not the call is recorded.

state
string <= 255 characters

The call’s current state.

stateChangedAt
string <date-time>

The date and time the call’s state last changed.

tags
Array of strings

A list of tag values associated with the call (e.g. ["Interested", "Meeting Booked"]).

to
string <= 255 characters

The phone number that the call was placed to.

uid
string <= 255 characters

The Outreach voice trace id.

updatedAt
string <date-time>

The date and time the call was last updated.

userCallType
string <= 255 characters

The type of call placed within the Outreach client; must be either "bridge" or "voip".

vendorCallId
string <= 63 characters

The call-id as recorded by the voice provider. Can be blank.

voicemailRecordingUrl
string <= 1024 characters

The URL of the call’s voicemail audio recording.

{
  • "answeredAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "dialedAt": "2019-08-24T14:15:22Z",
  • "direction": "string",
  • "externalVendor": "string",
  • "from": "string",
  • "note": "string",
  • "outcome": "string",
  • "recordingUrl": "string",
  • "returnedAt": "2019-08-24T14:15:22Z",
  • "sequenceAction": "string",
  • "shouldRecordCall": true,
  • "state": "string",
  • "stateChangedAt": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "to": "string",
  • "uid": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userCallType": "string",
  • "vendorCallId": "string",
  • "voicemailRecordingUrl": "string"
}

Call Relationships

data (object) or links (object) (callDisposition)

The associated call disposition. You can use only the attribute id to filter calls by callDisposition (e.g. filter[callDisposition][id]=X).

data (object) or links (object) (callPurpose)

The associated call purpose. You can use only the attribute id to filter calls by callPurpose (e.g. filter[callPurpose][id]=X).

data (object) or links (object) (opportunity)

The associated opportunity. You can use only the attribute id to filter calls by opportunity (e.g. filter[opportunity][id]=X).

data (object) or links (object) (phoneNumber)

The associated phone number of the prospect. You can use only the attribute id to filter calls by phoneNumber (e.g. filter[phoneNumber][id]=X).

data (object) or links (object) (prospect)

The associated prospect. You can use only the attribute id to filter calls by prospect (e.g. filter[prospect][id]=X).

data (object) or links (object) (sequence)

The associated sequence. You can use only the attribute id to filter calls by sequence (e.g. filter[sequence][id]=X).

data (object) or links (object) (sequenceState)

The associated sequence state. You can use only the attribute id to filter calls by sequenceState (e.g. filter[sequenceState][id]=X).

data (object) or links (object) (sequenceStep)

The associated sequence step. You can use only the attribute id to filter calls by sequenceStep (e.g. filter[sequenceStep][id]=X).

data (object) or links (object) (task)

The associated task. You can use only the attribute id to filter calls by task (e.g. filter[task][id]=X).

data (object) or links (object) (user)

The associated user. You can use only the attribute id to filter calls by user (e.g. filter[user][id]=X).

{
  • "callDisposition": {
    },
  • "callPurpose": {
    },
  • "opportunity": {
    },
  • "phoneNumber": {
    },
  • "prospect": {
    },
  • "sequence": {
    },
  • "sequenceState": {
    },
  • "sequenceStep": {
    },
  • "task": {
    },
  • "user": {
    }
}

Call Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Call has to external sources. provideDataConnections

⌵ Call Actions

Get a Collection of Calls

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/calls
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Call
SecuritybearerAuth and s2sAuthToken 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/calls
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Call by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/calls/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Call by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/calls/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}