List campaign call attempts

GET

api

account

{account_id}

campaigns

{campaign_id}

calls

List campaign call attempts

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls"

headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

GET https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls

Returns every call attempt for the campaign, joining the campaign call map with CDR data.

Authentication required

X-Auth-ID — your Vobiz account ID
X-Auth-Token — your Vobiz auth token

string

required

Your Vobiz account ID. Use the same value in X-Auth-ID.

string

required

Your Vobiz account ID, for example MA_XXXXXXXX.

string

required

The campaign whose attempts you want to inspect.

integer

default:"1"

Page number. This endpoint uses 1-based paging, unlike the offset style used elsewhere.

integer

default:"20"

Results per page. Maximum 200.

string

Filter attempts by status.

string

Searches both the to and from numbers.

Example

cURL

curl "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls?page=1&per_page=20" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

Campaign-side attempt data is returned even when the CDR service has no matching row yet, so a very recent attempt still appears. Save a returned call_uuid to correlate the attempt with CDRs or with Call lookup.

List campaign call attempts

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls"

headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Example

Example