SDKs

# Clone the repository and run from source (sdks/node/)
# npm publish is coming in a future release
import { Client, ByoursideError, verifyWebhook } from './src/index.js';

import { Client, ByoursideError } from './src/index.js';

const client = new Client({ apiKey: 'bys_ak_YOUR_KEY' });

// Place a call
const { callId } = await client.placeCall({
  to:        '+14155550123',
  objective: 'Confirm the appointment for tomorrow at 2 PM and ask if they need to reschedule.',
  fields: [
    { name: 'confirmed', type: 'boolean' },
    { name: 'new_time',  type: 'string'  },
  ],
});
console.log('Placed:', callId);

// Wait until terminal (default timeout: 3 minutes)
const result = await client.waitForCall(callId, { timeoutMs: 180_000, intervalMs: 5_000 });
console.log('Status:', result.status);
console.log('Summary:', result.summary);
console.log('Extracted:', result.extracted);

const calls = await client.listCalls({ limit: 20 });
calls.forEach((c) => console.log(c.callId, c.status));

try {
  const { callId } = await client.placeCall({
    to:        '+19001234567',
    objective: 'Test blocked destination',
  });
} catch (err) {
  if (err instanceof ByoursideError) {
    console.error(err.code);    // "destination_blocked"
    console.error(err.status);  // 400
    console.error(err.message);
  }
}

import express from 'express';
import { verifyWebhook } from './src/index.js';

const app = express();

// Parse the body as raw bytes so the signature can be verified.
app.post('/webhooks/bys', express.raw({ type: 'application/json' }), (req, res) => {
  const sig     = req.headers['x-bys-signature'];
  const rawBody = req.body.toString('utf8');

  if (!verifyWebhook(sig, rawBody, process.env.BYS_WEBHOOK_SECRET)) {
    return res.status(400).send('Bad signature');
  }

  const event = JSON.parse(rawBody);
  console.log('Event:', event.event, event.callId, event.status);
  res.status(200).send('OK');
});

# Clone the repository and run from source (sdks/python/)
# PyPI publish is coming in a future release
from byourside import Client

from byourside import Client, ByoursideError

client = Client(api_key='bys_ak_YOUR_KEY')

# Place a call
call = client.place_call(
    to='+14155550123',
    objective='Confirm the appointment for tomorrow at 2 PM and ask if they need to reschedule.',
    fields=[
        {'name': 'confirmed', 'type': 'boolean'},
        {'name': 'new_time',  'type': 'string' },
    ],
)
print('Placed:', call['callId'], 'status:', call['status'])

# Wait until terminal (default timeout: 180 seconds)
result = client.wait_for_call(call['callId'], timeout=180, interval=5)
print('Status:', result['status'])
print('Extracted:', result.get('extracted'))

calls = client.list_calls(limit=10)
for c in calls:
    print(c['callId'], c['status'])

try:
    call = client.place_call(to='+19001234567', objective='Test blocked destination')
except ByoursideError as e:
    print(e.code)    # "destination_blocked"
    print(e.status)  # 400
    print(str(e))

from flask import Flask, request, abort
from byourside import verify_webhook

app    = Flask(__name__)
SECRET = 'whsec_YOUR_SECRET'

@app.route('/webhooks/bys', methods=['POST'])
def bys_webhook():
    sig      = request.headers.get('X-BYS-Signature', '')
    raw_body = request.get_data(as_text=True)
    if not verify_webhook(sig, raw_body, SECRET):
        abort(400, 'Invalid signature')
    payload = request.get_json()
    print('Event:', payload['event'], payload['callId'], payload['status'])
    return '', 200