Get Calls by Campaign ID

Get all calls by campaign id.

Get all calls by campaign id. Returns an array of CallPublicDto. Supports pagination.

GEThttps://api.voxia.ai/campaigns/{campaignId}/calls

Authorization

Path parameters

campaignId*string

Id of the campaign as a string ObjectId value.

Query parameters

Response

Body

id*string

The id of the call. string representation of a ObjectId.

sessionId*string

The id of the session. string representation of a ObjectId.

campaignId*string

The id of the campaign. string representation of a ObjectId.

organizationId*string

The id of the organization. string representation of a ObjectId.

duration*number

The duration of the call in seconds.

hangUpReason*string

The reason for hanging up the call.

status*string

The status of the call.

failedReason*string

The reason for failing the call.

recordingUrl*string

The url of the recording.

createdAt*string

The datetime the call object was created in ISO string format.

Example: "2021-09-01T00:00:00.000Z"

updatedAt*string

The datetime the call was updated last time in ISO string format.

Example: "2021-09-01T00:00:00.000Z"

phoneFrom*string

The phone number.

phoneTo*string

The phone number.

messages*array of array

The ordered messages of the call.

contactId*string

Id of the contact within the system. String representation of a ObjectId.

summary*object

The summary object of the call.

goal*all of

The goal object of the call.

twilioAccountSid*string

Twilio account sid.

incomingCall*boolean

Boolean value defines if the call is incoming or outgoing. True if the call is incoming, false if the call is outgoing.

Request

const response = await fetch('https://api.voxia.ai/campaigns/{campaignId}/calls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "sessionId": "text",
    "campaignId": "text",
    "organizationId": "text",
    "duration": 0,
    "hangUpReason": "text",
    "status": "text",
    "failedReason": "text",
    "recordingUrl": "text",
    "createdAt": "2021-09-01T00:00:00.000Z",
    "updatedAt": "2021-09-01T00:00:00.000Z",
    "phoneFrom": "text",
    "phoneTo": "text",
    "messages": [
      []
    ],
    "contactId": "text",
    "goal": {
      "description": "text",
      "reached": false
    },
    "twilioAccountSid": "text",
    "incomingCall": false
  }
]

Last updated 4 months ago

[ { "id": "text", "sessionId": "text", "campaignId": "text", "organizationId": "text", "duration": 0, "hangUpReason": "text", "status": "text", "failedReason": "text", "recordingUrl": "text", "createdAt": "2021-09-01T00:00:00.000Z", "updatedAt": "2021-09-01T00:00:00.000Z", "phoneFrom": "text", "phoneTo": "text", "messages": [ [] ], "contactId": "text", "goal": { "description": "text", "reached": false }, "twilioAccountSid": "text", "incomingCall": false } ]