Preview the lead brief supplied before an outbound call

Reads current contact facts without queuing or dialing. Requires contact visibility within the authenticated workspace.

POST

https://api.channelautomation.com/api/voice-campaigns/context-preview/{contactId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

contactId
string
required
format: uuid

Request body JSON required

call_context
optional
object
- enabled
  optional
  boolean
- includeContact
  optional
  boolean
- template
  optional
  string
  maxLength: 6000
}

Returns

200

Resolved brief; nothing was queued or called

JSON

success
optional
boolean
preview
optional
object
- enabled
  optional
  boolean
- notes
  optional
  string
  or null
- missingFields
  optional
  array of
  string
}

400

Invalid context configuration

401

Authentication required

403

Contact access denied

404

Contact not found in this workspace

500

Context could not be resolved

503

Access could not be verified

Preview the lead brief supplied before an outbound call

curl --request POST \
  --url 'https://api.channelautomation.com/api/voice-campaigns/context-preview/<contactId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "call_context": {
    "enabled": true,
    "includeContact": true,
    "template": "string"
  }
}
'

const url = 'https://api.channelautomation.com/api/voice-campaigns/context-preview/<contactId>';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({call_context: {enabled: true, includeContact: true, template: 'string'}})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/voice-campaigns/context-preview/<contactId>"

payload = { "call_context": {
        "enabled": True,
        "includeContact": True,
        "template": "string"
    } }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "preview": {
    "enabled": true,
    "notes": "string",
    "missingFields": [
      "string"
    ]
  }
}