Get Campaign Contacts

Get all campaign contacts by campaign id.

Get all campaign contacts. Returns an array of ContactPublicDto. Supports pagination, status filtering and sorting options.

GEThttps://api.voxia.ai/campaigns/{campaignId}/contacts
Authorization
Path parameters
campaignId*string

Id of the campaign as a string ObjectId value.

Query parameters
Response
Body
id*string

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

name*string

The name of the contact.

phoneNumber*string

The phone number of the contact.

campaignId*string

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

status*string

The status of the contact.

failedReasonstring

The reason for failing the call.

createdAt*string

The date and time the contact was created in ISO format.

Request
const response = await fetch('https://api.voxia.ai/campaigns/{campaignId}/contacts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "id": "text",
    "name": "text",
    "phoneNumber": "text",
    "campaignId": "text",
    "status": "text",
    "failedReason": "text",
    "createdAt": "text"
  }
]

Last updated