Create an outbound call log

Creates an outbound voice call log entry and attributes it to the initiating human agent when a user ID is supplied.

POST

https://api.channelautomation.com/api/calls/initiate

Request body JSON required

contactId
string
required

workspaceId
string
required
phoneNumber
string
required
fromNumber
optional
string
userId
optional
string
Logged-in agent user ID for human-agent reporting.
agentUserId
optional
string
Alias for userId.
agentName
optional
string
agentEmail
optional
string

Returns

200

Call log created

400

Missing required fields

500

Failed to create call log

Create an outbound call log

curl --request POST \
  --url https://api.channelautomation.com/api/calls/initiate \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "string",
  "workspaceId": "string",
  "phoneNumber": "string",
  "fromNumber": "string",
  "userId": "string",
  "agentUserId": "string",
  "agentName": "string",
  "agentEmail": "string"
}
'

const url = 'https://api.channelautomation.com/api/calls/initiate';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    contactId: 'string',
    workspaceId: 'string',
    phoneNumber: 'string',
    fromNumber: 'string',
    userId: 'string',
    agentUserId: 'string',
    agentName: 'string',
    agentEmail: '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/calls/initiate"

payload = {
    "contactId": "string",
    "workspaceId": "string",
    "phoneNumber": "string",
    "fromNumber": "string",
    "userId": "string",
    "agentUserId": "string",
    "agentName": "string",
    "agentEmail": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)