Look up a campaign call

GET

api

account

{account_id}

campaigns

{campaign_id}

call-lookup

{call_uuid}

Look up a campaign call

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/call-lookup/{call_uuid} \
  --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}/call-lookup/{call_uuid}"

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}/call-lookup/{call_uuid}', 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}/call-lookup/{call_uuid}

Resolves a call UUID to its campaign and contact. Use it to confirm that a campaign owns a given call before acting on a CDR or webhook.

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 expected to own the call.

string

required

The call UUID, as returned by List call attempts, a CDR record, or a campaign webhook.

Example

cURL

curl "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/call-lookup/{call_uuid}" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

A call that does not belong to the campaign, or to the authenticated account, returns 404.

The Vobiz CDR pipeline uses an internal equivalent of this route, GET /internal/call-lookup/{call_uuid}, which is authenticated with X-Internal-Key and is not reachable through the public gateway. See Authentication.

⌘I

Look up a campaign call

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/call-lookup/{call_uuid} \
  --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}/call-lookup/{call_uuid}"

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}/call-lookup/{call_uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Example

Example