Voice Call API

<?php
$ch = curl_init('https://sendpk.com/apps/phone_calls/templates.php');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 15,
    CURLOPT_HTTPHEADER     => ['Authorization: ' . getenv('SENDPK_API_KEY')],
]);
$reply = json_decode((string) curl_exec($ch), true);

foreach ($reply['data']['templates'] ?? [] as $t) {
    if ($t['usable']) {
        echo $t['id'] . ' - ' . $t['title'] . ' (' . $t['duration'] . " s)\n";
    }
}

// Node.js 18+ (server-side)
const res = await fetch('https://sendpk.com/apps/phone_calls/templates.php', {
  headers: { 'Authorization': process.env.SENDPK_API_KEY },
});
const reply = await res.json();
const usable = (reply.data?.templates ?? []).filter(t => t.usable);
console.log(usable.map(t => `${t.id} - ${t.title} (${t.duration} s)`));

import os
import requests

res = requests.get(
    "https://sendpk.com/apps/phone_calls/templates.php",
    headers={"Authorization": os.environ["SENDPK_API_KEY"]},
    timeout=15,
)
for t in res.json().get("data", {}).get("templates", []):
    if t["usable"]:
        print(t["id"], "-", t["title"], f'({t["duration"]} s)')

<?php
$ch = curl_init('https://sendpk.com/apps/phone_calls/call.php');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 30,
    CURLOPT_HTTPHEADER     => [
        'Authorization: ' . getenv('SENDPK_API_KEY'),
        'Content-Type: application/json',
        'Idempotency-Key: order-58213-call-1',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'number'                => '+923001234567',
        'template_id'           => 3301118,
        'dtmf'                  => ['max_digits' => 1, 'timeout' => 10, 'valid_digits' => '12'],
        'notification_callback' => 'https://example.com/webhooks/voice-call',
    ]),
]);
$reply = json_decode((string) curl_exec($ch), true);
$callId = $reply['data']['id'] ?? null;   // save it

// Node.js 18+ (server-side)
const res = await fetch('https://sendpk.com/apps/phone_calls/call.php', {
  method: 'POST',
  headers: {
    'Authorization': process.env.SENDPK_API_KEY,
    'Content-Type': 'application/json',
    'Idempotency-Key': 'order-58213-call-1',
  },
  body: JSON.stringify({
    number: '+923001234567',
    template_id: 3301118,
    dtmf: { max_digits: 1, timeout: 10, valid_digits: '12' },
    notification_callback: 'https://example.com/webhooks/voice-call',
  }),
});
const reply = await res.json();
const callId = reply.success ? reply.data.id : null; // save it

import os
import requests

res = requests.post(
    "https://sendpk.com/apps/phone_calls/call.php",
    headers={
        "Authorization": os.environ["SENDPK_API_KEY"],
        "Idempotency-Key": "order-58213-call-1",
    },
    json={
        "number": "+923001234567",
        "template_id": 3301118,
        "dtmf": {"max_digits": 1, "timeout": 10, "valid_digits": "12"},
        "notification_callback": "https://example.com/webhooks/voice-call",
    },
    timeout=30,
)
reply = res.json()
call_id = reply["data"]["id"] if reply["success"] else None  # save it

{
  "success": true,
  "data": {
    "id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e5f",
    "status": "failed",
    "outcome": "no_answer",
    "number": "+923001234567",
    "template": { "id": 3301118, "title": "Order confirmation", "duration": 19 },
    "audio_url": null,
    "recording_seconds": 19,
    "dtmf": { "enabled": false },
    "created_at": 1770000000,
    "ringing_at": 1770000001,
    "answered_at": null,
    "ended_at": null,
    "duration": 0,
    "charge": { "status": "refunded", "final": true, "price": 3.0, "pulses": 1, "price_per_pulse": 3.0, "paid": 0.0, "refunded": 3.0, "currency": "PKR" },
    "error_code": null,
    "webhook": { "status": "sent", "last_event": "call.failed", "delivered": 2, "last_http_code": 200 }
  },
  "meta": { "request_id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e64" }
}

{
  "success": true,
  "data": {
    "id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e5f",
    "status": "initiated",
    "outcome": null,
    "number": "+923001234567",
    "template": { "id": 3301118, "title": "Order confirmation", "duration": 50 },
    "audio_url": null,
    "recording_seconds": 50,
    "dtmf": { "enabled": true, "max_digits": 1, "timeout": 10, "valid_digits": "12", "digits": null, "valid": null },
    "created_at": 1770000000,
    "ringing_at": null,
    "answered_at": null,
    "ended_at": null,
    "duration": null,
    "charge": { "status": "charged", "final": false, "price": 6.0, "pulses": 2, "price_per_pulse": 3.0, "paid": 6.0, "refunded": 0.0, "currency": "PKR" },
    "error_code": null,
    "webhook": { "status": "sent", "last_event": "call.initiated", "delivered": 1, "last_http_code": 200 }
  },
  "meta": { "request_id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e65" }
}

{
  "success": true,
  "data": {
    "id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e5f",
    "status": "failed",
    "outcome": "unknown",
    "number": "+923001234567",
    "template": { "id": 3301118, "title": "Order confirmation", "duration": 50 },
    "audio_url": null,
    "recording_seconds": 50,
    "dtmf": { "enabled": false },
    "created_at": 1770000000,
    "ringing_at": null,
    "answered_at": null,
    "ended_at": null,
    "duration": null,
    "charge": { "status": "refunded", "final": true, "price": 6.0, "pulses": 2, "price_per_pulse": 3.0, "paid": 0.0, "refunded": 6.0, "currency": "PKR" },
    "error_code": "PROVIDER_UNKNOWN",
    "webhook": { "status": "none", "last_event": "call.failed", "delivered": 0, "last_http_code": null }
  },
  "meta": { "request_id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e66" }
}

const crypto = require('crypto');

// rawBody = the exact bytes received (e.g. express.raw({ type: 'application/json' }))
function isFromSendpk(rawBody, header) {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', process.env.SENDPK_API_KEY)
    .update(rawBody)
    .digest('hex');
  const got = header || '';
  return got.length === expected.length
    && crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(got));
}

import hashlib
import hmac
import os


def is_from_sendpk(raw_body: bytes, header: str) -> bool:
    expected = "sha256=" + hmac.new(
        os.environ["SENDPK_API_KEY"].encode(), raw_body, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(expected, header or "")

Loading...

Loading...

Loading...

Loading...

// Node.js 18+. Retries on a timeout or a 5xx with the SAME Idempotency-Key.
async function sendpkVoiceCall(number, templateId, idempotencyKey, extra = {}) {
  const body = JSON.stringify({ number, template_id: templateId, ...extra });

  for (let attempt = 1; attempt <= 3; attempt++) {
    try {
      const res = await fetch('https://sendpk.com/apps/phone_calls/call.php', {
        method: 'POST',
        headers: {
          'Authorization': process.env.SENDPK_API_KEY,
          'Content-Type': 'application/json',
          'Idempotency-Key': idempotencyKey,
        },
        body,
        signal: AbortSignal.timeout(30000),
      });
      if (res.status < 500) {
        return await res.json(); // success, or a 4xx you must fix
      }
    } catch (err) {
      // timeout / network error: retry with the same key
    }
    await new Promise(r => setTimeout(r, attempt * 2000));
  }
  return { success: false, error: { code: 'NO_REPLY', message: 'No reply from SENDPK' } };
}

const reply = await sendpkVoiceCall('+923001234567', 3301118, 'order-58213-call-1', {
  dtmf: { max_digits: 1, timeout: 10, valid_digits: '12' },
  notification_callback: 'https://example.com/webhooks/voice-call',
});
console.log(reply.success ? `Call id: ${reply.data.id}` : `Not placed: ${reply.error.code}`);

import os
import time

import requests


def sendpk_voice_call(number, template_id, idempotency_key, **extra):
    """Retries on a timeout or a 5xx with the SAME Idempotency-Key."""
    body = {"number": number, "template_id": template_id, **extra}
    for attempt in range(1, 4):
        try:
            res = requests.post(
                "https://sendpk.com/apps/phone_calls/call.php",
                headers={
                    "Authorization": os.environ["SENDPK_API_KEY"],
                    "Idempotency-Key": idempotency_key,
                },
                json=body,
                timeout=30,
            )
            if res.status_code < 500:
                return res.json()  # success, or a 4xx you must fix
        except requests.RequestException:
            pass  # timeout / network error: retry with the same key
        time.sleep(attempt * 2)
    return {"success": False, "error": {"code": "NO_REPLY", "message": "No reply from SENDPK"}}


reply = sendpk_voice_call(
    "+923001234567", 3301118, "order-58213-call-1",
    dtmf={"max_digits": 1, "timeout": 10, "valid_digits": "12"},
    notification_callback="https://example.com/webhooks/voice-call",
)
print(reply["data"]["id"] if reply["success"] else reply["error"]["code"])

// Node.js + Express
const express = require('express');
const crypto = require('crypto');
const app = express();

app.post('/webhooks/voice-call', express.raw({ type: 'application/json' }), (req, res) => {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', process.env.SENDPK_API_KEY)
    .update(req.body)              // raw bytes, NOT re-encoded JSON
    .digest('hex');
  const got = req.get('X-SENDPK-Signature') || '';
  if (got.length !== expected.length || !crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(got))) {
    return res.sendStatus(401);
  }

  const call = JSON.parse(req.body.toString('utf8'));
  // Skip repeats with call.event_id, then act on the final result:
  if (call.status === 'completed') {
    console.log('Answered. Key pressed:', call.dtmf.digits);
  } else if (call.status === 'failed') {
    console.log('Not answered:', call.outcome, 'refunded:', call.charge.refunded);
  }
  res.sendStatus(200);             // answer fast (within 5 seconds)
});

app.listen(3000);

# Python + Flask
import hashlib
import hmac
import json
import os

from flask import Flask, abort, request

app = Flask(__name__)


@app.post("/webhooks/voice-call")
def voice_call_webhook():
    raw = request.get_data()  # raw bytes, NOT re-encoded JSON
    expected = "sha256=" + hmac.new(
        os.environ["SENDPK_API_KEY"].encode(), raw, hashlib.sha256
    ).hexdigest()
    if not hmac.compare_digest(expected, request.headers.get("X-SENDPK-Signature", "")):
        abort(401)

    call = json.loads(raw)
    # Skip repeats with call["event_id"], then act on the final result:
    if call["status"] == "completed":
        print("Answered. Key pressed:", call["dtmf"].get("digits"))
    elif call["status"] == "failed":
        print("Not answered:", call["outcome"])
    return "", 200  # answer fast (within 5 seconds)

<?php
$id = '0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e5f';
$ch = curl_init('https://sendpk.com/apps/phone_calls/status.php?id=' . rawurlencode($id));
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 15,
    CURLOPT_HTTPHEADER     => ['Authorization: ' . getenv('SENDPK_API_KEY')],
]);
$call = json_decode((string) curl_exec($ch), true)['data'] ?? null;

if ($call && in_array($call['status'], ['completed', 'failed'], true)) {
    echo $call['outcome'] . ', paid PKR ' . $call['charge']['paid'] . "\n";
}

const id = '0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e5f';
const res = await fetch(`https://sendpk.com/apps/phone_calls/status.php?id=${encodeURIComponent(id)}`, {
  headers: { 'Authorization': process.env.SENDPK_API_KEY },
});
const { data: call } = await res.json();
if (call && ['completed', 'failed'].includes(call.status)) {
  console.log(call.outcome, 'paid PKR', call.charge.paid);
}

import os
import requests

res = requests.get(
    "https://sendpk.com/apps/phone_calls/status.php",
    params={"id": "0192f4c3-7a1b-7c2d-9e3f-0a1b2c3d4e5f"},
    headers={"Authorization": os.environ["SENDPK_API_KEY"]},
    timeout=15,
)
call = res.json().get("data")
if call and call["status"] in ("completed", "failed"):
    print(call["outcome"], "paid PKR", call["charge"]["paid"])