Slide API

import { SlideClient } from '@synquic/slide';

const slide = new SlideClient({ apiKey: process.env.SLIDE_API_KEY! });

// Send a transactional email
const sent = await slide.email.send({
  templateId: 'tmpl_welcome',
  recipient: { to: 'user@example.com', firstName: 'Rahul' },
  fromName: 'Acme Store',
  fromEmail: 'orders@acme.com',
  variables: { orderId: '#1042', total: '₹2,499' },
});
console.log(sent.messageId, sent.status);

// Send a WhatsApp template
const msg = await slide.whatsapp.sendTemplate({
  to: '+919876543210',
  templateName: 'order_shipped',
  languageCode: 'en',
});
console.log(msg.wamid);

// Initiate an outbound AI voice call
const call = await slide.voice.initiateOutboundCall({
  agentId: 'va_01JXYZ...',
  toNumber: '+919876543210',
  callContext: { customerName: 'Priya', purpose: 'appointment_confirmation' },
});
console.log(call.id, call.status); // vc_01J... INITIATED

// List contacts with pagination
const contacts = await slide.contacts.list({ page: 1, limit: 50 });
console.log(contacts.meta.total, contacts.data.length);

// Shopify - validate discount code
const discount = await slide.shopify.validateDiscount({ code: 'SAVE20' });
if (discount.valid) {
  console.log(`${discount.value}% off, expires ${discount.expiresAt}`);
}

// Instagram - get profile and send a DM
const profile = await slide.instagram.getProfile();
await slide.instagram.sendMessage({
  recipientIgsid: '123456789',
  message: 'Thanks for reaching out!',
});

// SMS, RCS, and OTP
await slide.sms.send({
  senderId: 'ACMEIN',
  to: ['919876543210'],
  message: 'Your order has shipped!',
});
const otp = await slide.otp.send({ widgetId: 'wgt_01J...', identifier: '+919876543210' });
await slide.otp.verify({ requestId: otp.requestId, otp: '123456' });
await slide.rcs.send({ to: '919876543210', templateId: 'rcst_01J...' });

// WhatsApp conversations and campaigns
const history = await slide.whatsapp.getConversationByPhone({ phone: '919876543210', limit: 50 });
const campaigns = await slide.whatsapp.listCampaigns({ page: 1, limit: 20 });

import {
  SlideClient,
  SlideAuthError,
  SlideScopeError,
  SlideValidationError,
  SlideNotFoundError,
  SlideError,
} from '@synquic/slide';

const slide = new SlideClient({ apiKey: process.env.SLIDE_API_KEY! });

try {
  await slide.email.send({ /* ... */ });
} catch (err) {
  if (err instanceof SlideAuthError) {
    console.error('Invalid API key - check SLIDE_API_KEY');
  } else if (err instanceof SlideScopeError) {
    console.error('Missing scope:', err.message); // e.g. "email:send"
  } else if (err instanceof SlideValidationError) {
    console.error('Bad request:', err.body);
  } else if (err instanceof SlideNotFoundError) {
    console.error('Resource not found');
  } else if (err instanceof SlideError) {
    console.error(`HTTP ${err.statusCode}:`, err.message);
  }
}

import os
from synquic_slide import SlideClient

slide = SlideClient(api_key=os.environ["SLIDE_API_KEY"])

# Send a transactional email
slide.email.send(
    recipient={"to": "user@example.com", "firstName": "Rahul"},
    template_id="tmpl_welcome",
    from_name="Acme Store",
    from_email="orders@acme.com",
    variables={"orderId": "#1042", "total": "₹2,499"},
)

# Send a WhatsApp template
msg = slide.whatsapp.send_template(
    to="+919876543210",
    template_name="order_shipped",
    language_code="en",
)
print(msg["wamid"])

# Initiate an outbound AI voice call
call = slide.voice.initiate_outbound_call(
    agent_id="va_01JXYZ...",
    to_number="+919876543210",
    call_context={"customerName": "Priya", "purpose": "appointment_confirmation"},
)
print(call["id"], call["status"])  # vc_01J... INITIATED

# List contacts
contacts = slide.contacts.list(page=1, limit=50)
print(contacts["meta"]["total"])

# Validate a Shopify discount code
discount = slide.shopify.validate_discount(code="SAVE20")
if discount["valid"]:
    print(f'{discount["value"]}% off, expires {discount["expiresAt"]}')

# SMS, RCS, and OTP
slide.sms.send(sender_id="ACMEIN", to=["919876543210"], message="Your order has shipped!")
otp = slide.otp.send(widget_id="wgt_01J...", identifier="+919876543210")
slide.otp.verify(request_id=otp["requestId"], otp="123456")
slide.rcs.send(to="919876543210", template_id="rcst_01J...")

import asyncio
import os
from synquic_slide import AsyncSlideClient

async def main():
    async with AsyncSlideClient(api_key=os.environ["SLIDE_API_KEY"]) as slide:
        # Fetch contacts and send a WhatsApp message concurrently
        contacts, agents = await asyncio.gather(
            slide.contacts.list(page=1, limit=20),
            slide.voice.list_agents(),
        )
        print(f'{contacts["meta"]["total"]} contacts, {agents["meta"]["total"]} agents')

        call = await slide.voice.initiate_outbound_call(
            agent_id=agents["data"][0]["id"],
            to_number="+919876543210",
            call_context={"customerName": "Priya"},
        )
        print(call["id"], call["status"])

asyncio.run(main())

from synquic_slide import (
    SlideClient,
    SlideAuthError,
    SlideScopeError,
    SlideNotFoundError,
    SlideValidationError,
    SlideError,
)

slide = SlideClient(api_key="sk_live_...")

try:
    slide.email.send(...)
except SlideAuthError:
    print("Invalid API key - check SLIDE_API_KEY")
except SlideScopeError as e:
    print(f"Missing scope: {e}")      # e.g. "email:send"
except SlideValidationError as e:
    print(f"Bad request: {e.body}")
except SlideNotFoundError:
    print("Resource not found")
except SlideError as e:
    print(f"HTTP {e.status_code}: {e}")

export SLIDE_API_KEY="sk_live_YOUR_API_KEY"
export SLIDE_BASE="https://slide.synquic.com/api/v1"

# Send an email using a template
curl -X POST "$SLIDE_BASE/email/send" \
 -H "Authorization: Bearer $SLIDE_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "templateId": "YOUR_TEMPLATE_ID",
 "recipient": { "to": "hello@example.com", "firstName": "Alex" },
 "variables": { "company": "Acme" },
 "fromName": "Acme",
 "fromEmail": "hi@acme.com"
 }'

# Initiate an outbound voice call
curl -X POST "$SLIDE_BASE/voice/calls/outbound" \
 -H "Authorization: Bearer $SLIDE_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{ "agentId": "va_01JXYZ...", "toNumber": "+919876543210" }'

const BASE = 'https://slide.synquic.com/api/v1';
const KEY  = process.env.SLIDE_API_KEY!;

const headers = {
  'Authorization': `Bearer ${KEY}`,
  'Content-Type': 'application/json',
};

// Send email
const emailRes = await fetch(`${BASE}/email/send`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    templateId: 'YOUR_TEMPLATE_ID',
    recipient: { to: 'user@example.com', firstName: 'Alex' },
    variables: { company: 'Acme Inc' },
    fromName: 'Acme Inc',
    fromEmail: 'hi@acme.com',
  }),
});
const email = await emailRes.json();
console.log(email); // { messageId, status, to, templateId, templateName }

// Search Shopify products
const prodRes = await fetch(`${BASE}/shopify/products/search?q=sneakers&limit=5`, { headers });
const products = await prodRes.json();
console.log(products.data); // [{ id, title, vendor, variants }, ...]

# Include in every request
curl https://slide.synquic.com/api/v1/email/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json"

{
 "statusCode": 429,
 "error": "Too Many Requests",
 "message": "Rate limit exceeded. Try again in 23 seconds.",
 "retryAfter": 23
}

async function requestWithBackoff(url: string, init: RequestInit, maxRetries = 5) {
  for (let attempt = 0; attempt <= maxRetries; attempt++) {
    const res = await fetch(url, init);
    if (res.status !== 429) return res;

    // Honor Retry-After, fall back to exponential backoff with jitter
    const retryAfter = Number(res.headers.get('Retry-After'));
    const backoffMs = Number.isFinite(retryAfter) && retryAfter > 0
      ? retryAfter * 1000
      : Math.min(60_000, 2 ** attempt * 1000) + Math.random() * 500;
    await new Promise((r) => setTimeout(r, backoffMs));
  }
  throw new Error('Rate limited: retries exhausted');
}

{
 "statusCode": 403,
 "error": "Forbidden",
 "message": "Request from IP 203.0.113.42 is not allowed for this API key"
}

{
 "statusCode": 400,
 "error": "Bad Request",
 "message": "recipient.to must be a valid email address"
}

curl "https://slide.synquic.com/api/v1/contacts?page=1&limit=50&search=john" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const params = new URLSearchParams({ page: '1', limit: '50', search: 'john' });
const res = await fetch(`https://slide.synquic.com/api/v1/contacts?${params}`, {
 headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' },
});
const { data, meta } = await res.json();

{
 "data": [
 {
 "id": "cnt_abc123",
 "username": "john_doe",
 "name": "John Doe",
 "email": "john@example.com",
 "phone": "+91987654321",
 "profilePic": "https://...",
 "source": "instagram",
 "tags": [],
 "createdAt": "2026-01-15T10:30:00Z"
 }
 ],
 "meta": {
 "total": 312,
 "page": 1,
 "limit": 50,
 "totalPages": 7
 }
}

curl -X POST "https://slide.synquic.com/api/v1/contacts/cnt_abc123/block" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"reason": "Spam"}'

{
 "success": true,
 "contactId": "cnt_abc123",
 "isBlocked": true
}

curl -X POST "https://slide.synquic.com/api/v1/contacts/cnt_abc123/unblock" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X POST https://slide.synquic.com/api/v1/messages/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "to": "+919876543210",
 "channel": "whatsapp",
 "template": {
 "name": "order_confirmation",
 "languageCode": "en",
 "variables": { "1": "John", "2": "ORD-12345" }
 }
 }'

const response = await fetch('https://slide.synquic.com/api/v1/messages/send', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 to: '+919876543210',
 channel: 'whatsapp',
 template: {
 name: 'order_confirmation',
 languageCode: 'en',
 variables: { '1': 'John', '2': 'ORD-12345' },
 },
 }),
});

const data = await response.json();
// { status: "sent", channelUsed: "whatsapp", messageId: "wamid.HBg...", attempts: [...] }

curl -X POST https://slide.synquic.com/api/v1/messages/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "to": "+919876543210",
 "channel": "whatsapp",
 "fallbackChannels": ["sms"],
 "message": "Your order ORD-12345 has shipped!",
 "template": {
 "name": "order_shipped",
 "languageCode": "en"
 },
 "sms": { "senderId": "ACMEIN" }
 }'

import requests

response = requests.post(
 'https://slide.synquic.com/api/v1/messages/send',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'to': '+919876543210',
 'channel': 'whatsapp',
 'fallbackChannels': ['sms'],
 'message': 'Your order ORD-12345 has shipped!',
 'template': {
 'name': 'order_shipped',
 'languageCode': 'en',
 },
 'sms': { 'senderId': 'ACMEIN' },
 }
)

data = response.json()
# {'status': 'sent', 'channelUsed': 'whatsapp', 'messageId': 'wamid.HBg...', 'attempts': [...]}

{
 "status": "sent",
 "channelUsed": "whatsapp",
 "messageId": "wamid.HBg...",
 "attempts": [
 { "channel": "whatsapp", "status": "sent", "messageId": "wamid.HBg..." }
 ]
}

// 400: missing required field(s)
{
 "message": "Missing required field(s) for channel \"email\": template.id, email.fromEmail"
}

// 403: insufficient scope
{
 "message": "Insufficient scope. Required: whatsapp:send"
}

// 502: all channels failed
{
 "message": "All channels failed to deliver the message",
 "attempts": [
 { "channel": "whatsapp", "status": "failed", "error": "..." },
 { "channel": "sms", "status": "failed", "error": "..." }
 ]
}

curl -X POST https://slide.synquic.com/api/v1/email/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "templateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "recipient": {
 "to": "user@example.com",
 "firstName": "John"
 },
 "variables": {
 "company": "Acme Corp",
 "order_id": "ORD-12345"
 },
 "fromName": "Your Company",
 "fromEmail": "hello@yourdomain.com"
 }'

const response = await fetch('https://slide.synquic.com/api/v1/email/send', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 templateId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
 recipient: {
 to: 'user@example.com',
 firstName: 'John',
 },
 variables: {
 company: 'Acme Corp',
 order_id: 'ORD-12345',
 },
 fromName: 'Your Company',
 fromEmail: 'hello@yourdomain.com',
 }),
});

const data = await response.json();
// { messageId: "msg_01J...", status: "sent", to: "user@example.com",
// templateId: "a1b2c3d4...", templateName: "Order Confirmation" }

import requests

response = requests.post(
 'https://slide.synquic.com/api/v1/email/send',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'templateId': 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
 'recipient': {
 'to': 'user@example.com',
 'firstName': 'John',
 },
 'variables': {
 'company': 'Acme Corp',
 'order_id': 'ORD-12345',
 },
 'fromName': 'Your Company',
 'fromEmail': 'hello@yourdomain.com',
 }
)

data = response.json()
# {'messageId': 'msg_01J...', 'status': 'sent', 'to': 'user@example.com',
# 'templateId': 'a1b2c3d4...', 'templateName': 'Order Confirmation'}

{
 "messageId": "msg_01JXYZ...",
 "status": "sent",
 "to": "user@example.com",
 "templateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "templateName": "Order Confirmation"
}

curl https://slide.synquic.com/api/v1/email/templates \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch('https://slide.synquic.com/api/v1/email/templates', {
 headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' },
});
const { data, meta } = await res.json();

{
 "data": [
 {
 "id": "tpl_01JXYZ...",
 "name": "Welcome Email",
 "subject": "Welcome to {{company_name}}",
 "createdAt": "2026-01-15T09:00:00.000Z",
 "updatedAt": "2026-02-10T12:30:00.000Z"
 }
 ],
 "meta": {
 "total": 1,
 "page": 1,
 "limit": 20,
 "totalPages": 1
 }
}

curl https://slide.synquic.com/api/v1/email/templates/tpl_01JXYZ \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch('https://slide.synquic.com/api/v1/email/templates/tpl_01JXYZ', {
 headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' },
});
const template = await res.json();

{
 "id": "tpl_01JXYZ...",
 "name": "Welcome Email",
 "subject": "Welcome to {{company_name}}",
 "html": "<h1>Welcome!</h1><p>Thanks for joining {{company_name}}.</p>",
 "text": "Welcome! Thanks for joining {{company_name}}.",
 "createdAt": "2026-01-15T09:00:00.000Z",
 "updatedAt": "2026-02-10T12:30:00.000Z"
}

curl "https://slide.synquic.com/api/v1/email/contacts?page=1&limit=50" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "ec_01JXYZ...",
 "email": "john@example.com",
 "firstName": "John",
 "lastName": "Doe",
 "subscribed": true,
 "createdAt": "2026-02-01T09:00:00.000Z"
 }
 ],
 "meta": { "total": 312, "page": 1, "limit": 50, "totalPages": 7 }
}

curl -X POST https://slide.synquic.com/api/v1/email/contacts \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{ "email": "john@example.com", "firstName": "John", "lastName": "Doe" }'

{
 "id": "ec_01JXYZ...",
 "email": "john@example.com",
 "firstName": "John",
 "lastName": "Doe",
 "subscribed": true,
 "createdAt": "2026-04-08T12:30:00.000Z"
}

curl https://slide.synquic.com/api/v1/instagram/profile \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch('https://slide.synquic.com/api/v1/instagram/profile', {
 headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' },
});
const profile = await res.json();

{
 "id": "17841400455970661",
 "username": "yourbusiness",
 "name": "Your Business Name",
 "biography": "Official business account",
 "followersCount": 12450,
 "followsCount": 310,
 "mediaCount": 89,
 "profilePictureUrl": "https://example.com/profile.jpg",
 "website": "https://yourbusiness.com"
}

curl "https://slide.synquic.com/api/v1/instagram/conversations?page=1&limit=20" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

import requests

res = requests.get(
 'https://slide.synquic.com/api/v1/instagram/conversations',
 headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'},
 params={'page': 1, 'limit': 20}
)
data = res.json()

{
 "data": [
 {
 "id": "conv_01JXYZ...",
 "senderId": "112233445566778",
 "senderUsername": "johndoe",
 "senderName": "John Doe",
 "lastMessage": "Thanks for the info!",
 "lastMessageAt": "2026-03-24T08:15:00.000Z",
 "unreadCount": 2
 }
 ],
 "meta": {
 "total": 87,
 "page": 1,
 "limit": 20,
 "totalPages": 5
 }
}

curl -X POST https://slide.synquic.com/api/v1/instagram/messages \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "recipientIgsid": "112233445566778",
 "message": "Hi! Thanks for reaching out. How can we help you today?"
 }'

const res = await fetch('https://slide.synquic.com/api/v1/instagram/messages', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 recipientIgsid: '112233445566778',
 message: 'Hi! Thanks for reaching out. How can we help you today?',
 }),
});
const result = await res.json();
// { messageId: 'igmsg_01JXYZ...', status: 'sent' }

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/instagram/messages',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'recipientIgsid': '112233445566778',
 'message': 'Hi! Thanks for reaching out.',
 }
)
print(res.json()) # {'messageId': 'igmsg_01JXYZ...', 'status': 'sent'}

curl https://slide.synquic.com/api/v1/instagram/insights \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch('https://slide.synquic.com/api/v1/instagram/insights', {
 headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' },
});
const insights = await res.json();

{
 "followerCount": 12450,
 "followsDelta": 23,
 "reach": 4821,
 "profileViews": 1340,
 "impressions": 9123,
 "websiteClicks": 89,
 "period": "last_7_days",
 "updatedAt": "2026-03-24T00:00:00.000Z"
}

# Send a simple text template with one body variable
curl -X POST https://slide.synquic.com/api/v1/whatsapp/send-template \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "to": "919876543210",
 "templateName": "order_confirmation",
 "languageCode": "en",
 "components": [
 {
 "type": "body",
 "parameters": [
 { "type": "text", "text": "John" },
 { "type": "text", "text": "ORD-12345" },
 { "type": "text", "text": "₹2,499" }
 ]
 }
 ]
 }'

const response = await fetch('https://slide.synquic.com/api/v1/whatsapp/send-template', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 to: '919876543210',
 templateName: 'order_confirmation',
 languageCode: 'en',
 components: [
 {
 type: 'body',
 parameters: [
 { type: 'text', text: 'John' },
 { type: 'text', text: 'ORD-12345' },
 { type: 'text', text: '₹2,499' },
 ],
 },
 ],
 }),
});

const data = await response.json();
// { wamid: "wamid.HBgM...", conversationId: "conv_01J...", status: "sent" }

import requests

response = requests.post(
 'https://slide.synquic.com/api/v1/whatsapp/send-template',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'to': '919876543210',
 'templateName': 'order_confirmation',
 'languageCode': 'en',
 'components': [
 {
 'type': 'body',
 'parameters': [
 {'type': 'text', 'text': 'John'},
 {'type': 'text', 'text': 'ORD-12345'},
 {'type': 'text', 'text': '₹2,499'},
 ],
 },
 ],
 }
)

data = response.json()
# {'wamid': 'wamid.HBgM...', 'conversationId': 'conv_01J...', 'status': 'sent'}

{
 "wamid": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSMjYxMDgx...",
 "conversationId": "conv_01JXYZ...",
 "status": "sent"
}

// Text-only template (no variables)
{
 "to": "919876543210",
 "templateName": "welcome_message",
 "languageCode": "en"
}

// Template with image header + body variables
{
 "to": "919876543210",
 "templateName": "promo_offer",
 "languageCode": "en",
 "components": [
 {
 "type": "header",
 "parameters": [
 { "type": "image", "image": { "link": "https://example.com/promo.jpg" } }
 ]
 },
 {
 "type": "body",
 "parameters": [
 { "type": "text", "text": "John" },
 { "type": "text", "text": "20%" }
 ]
 }
 ]
}

// OTP / Verification template (body + copy-code button)
{
 "to": "919876543210",
 "templateName": "verification",
 "languageCode": "en",
 "components": [
 {
 "type": "body",
 "parameters": [{ "type": "text", "text": "654321" }]
 },
 {
 "type": "button",
 "sub_type": "url",
 "index": "0",
 "parameters": [{ "type": "text", "text": "654321" }]
 }
 ]
}

curl "https://slide.synquic.com/api/v1/whatsapp/logs?page=1&limit=20&direction=outbound" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch(
 'https://slide.synquic.com/api/v1/whatsapp/logs?page=1&limit=20&direction=outbound',
 { headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' } }
);
const { data, meta } = await res.json();

{
 "data": [
 {
 "id": "msg_01JXYZ...",
 "wamid": "wamid.HBgM...",
 "direction": "outbound",
 "type": "template",
 "status": "delivered",
 "content": { "templateName": "order_confirmation", "languageCode": "en" },
 "templateName": "order_confirmation",
 "templateCategory": "UTILITY",
 "isTemplate": true,
 "isBillable": true,
 "billingAmountPaise": 12,
 "source": "API",
 "sourceName": "Production Key",
 "timestamp": "2026-04-08T12:30:00.000Z",
 "conversation": {
 "id": "conv_01J...",
 "customerWaId": "919876543210",
 "customerName": "John Doe"
 }
 }
 ],
 "meta": { "total": 142, "page": 1, "limit": 20, "totalPages": 8 }
}

curl "https://slide.synquic.com/api/v1/whatsapp/templates?status=APPROVED" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch(
 'https://slide.synquic.com/api/v1/whatsapp/templates?status=APPROVED',
 { headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' } }
);
const templates = await res.json();

{
 "data": [
 {
 "id": "tpl_01JXYZ...",
 "name": "order_confirmation",
 "category": "UTILITY",
 "language": "en",
 "status": "APPROVED",
 "components": [
 {
 "type": "BODY",
 "text": "Hi {{1}}, your order {{2}} of {{3}} has been confirmed!"
 }
 ],
 "createdAt": "2026-01-10T08:00:00.000Z"
 },
 {
 "id": "tpl_02ABCD...",
 "name": "verification",
 "category": "AUTHENTICATION",
 "language": "en",
 "status": "APPROVED",
 "components": [
 {
 "type": "BODY",
 "text": "Your verification code is {{1}}"
 },
 {
 "type": "BUTTONS",
 "buttons": [{ "type": "URL", "text": "Copy Code", "url": "https://..." }]
 }
 ],
 "createdAt": "2026-01-05T10:00:00.000Z"
 }
 ],
 "meta": { "total": 12, "page": 1, "limit": 25, "totalPages": 1 }
}

curl -X POST https://slide.synquic.com/api/v1/whatsapp/header-media/upload \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -F "file=@promo.jpg"

{
 "mediaId": "wamedia_01JXYZ...",
 "url": "https://slide.synquic.com/media/wamedia_01JXYZ.jpg",
 "mimeType": "image/jpeg"
}

curl "https://slide.synquic.com/api/v1/whatsapp/conversations/by-phone?phone=919876543210&limit=50" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch(
 'https://slide.synquic.com/api/v1/whatsapp/conversations/by-phone?phone=919876543210&limit=50',
 { headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' } }
);
const conversation = await res.json();
// conversation.data is chronological: oldest message first

import requests

res = requests.get(
 'https://slide.synquic.com/api/v1/whatsapp/conversations/by-phone',
 headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'},
 params={'phone': '919876543210', 'limit': 50}
)
conversation = res.json()

{
 "conversationId": "conv_01JXYZ...",
 "customerWaId": "919876543210",
 "customerName": "John Doe",
 "data": [
 {
 "id": "msg_01JXYZ...",
 "wamid": "wamid.HBgM...",
 "direction": "outbound",
 "type": "template",
 "status": "read",
 "content": { "templateName": "order_confirmation" },
 "templateName": "order_confirmation",
 "mediaUrl": null,
 "mediaMimeType": null,
 "errorCode": null,
 "errorMessage": null,
 "timestamp": "2026-04-08T12:30:00.000Z",
 "createdAt": "2026-04-08T12:30:00.000Z"
 },
 {
 "id": "msg_02ABCD...",
 "wamid": "wamid.HBgN...",
 "direction": "inbound",
 "type": "text",
 "status": "received",
 "content": { "body": "Thanks! When will it arrive?" },
 "templateName": null,
 "mediaUrl": null,
 "mediaMimeType": null,
 "errorCode": null,
 "errorMessage": null,
 "timestamp": "2026-04-08T12:31:12.000Z",
 "createdAt": "2026-04-08T12:31:12.000Z"
 }
 ]
}

curl "https://slide.synquic.com/api/v1/whatsapp/campaigns?page=1&limit=20&status=COMPLETED" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "wac_01JXYZ...",
 "name": "April Promo",
 "status": "COMPLETED",
 "templateId": "tpl_01JXYZ...",
 "templateName": "promo_offer",
 "totalRecipients": 5000,
 "sentCount": 4980,
 "deliveredCount": 4870,
 "scheduledAt": null,
 "createdAt": "2026-04-01T09:00:00.000Z"
 }
 ],
 "meta": { "total": 6, "page": 1, "limit": 20, "totalPages": 1 }
}

curl "https://slide.synquic.com/api/v1/whatsapp/campaigns/wac_01JXYZ" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl "https://slide.synquic.com/api/v1/whatsapp/campaigns/wac_01JXYZ/analytics" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "campaignId": "wac_01JXYZ...",
 "totalRecipients": 5000,
 "sent": 4980,
 "delivered": 4870,
 "read": 3120,
 "clicked": 640,
 "replied": 212,
 "converted": 87,
 "failed": 20,
 "deliveryRate": 97.79,
 "readRate": 64.07,
 "clickRate": 13.14
}

curl -X POST https://slide.synquic.com/api/v1/whatsapp/campaigns \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "name": "April Promo",
 "templateId": "tpl_01JXYZ...",
 "phones": ["919876543210", "919876543211"],
 "scheduledAt": "2026-04-15T10:00:00.000Z",
 "scheduleTimezone": "Asia/Kolkata"
 }'

const res = await fetch('https://slide.synquic.com/api/v1/whatsapp/campaigns', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 name: 'April Promo',
 templateId: 'tpl_01JXYZ...',
 phones: ['919876543210', '919876543211'],
 scheduledAt: '2026-04-15T10:00:00.000Z',
 scheduleTimezone: 'Asia/Kolkata',
 }),
});
const campaign = await res.json();
// { id: 'wac_01J...', status: 'DRAFT', totalRecipients: 2, ... }

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/whatsapp/campaigns',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'name': 'April Promo',
 'templateId': 'tpl_01JXYZ...',
 'phones': ['919876543210', '919876543211'],
 }
)
campaign = res.json()
print(campaign['id'], campaign['status'])  # wac_01J... DRAFT

{
 "id": "wac_01JXYZ...",
 "name": "April Promo",
 "status": "DRAFT",
 "templateId": "tpl_01JXYZ...",
 "totalRecipients": 2,
 "scheduledAt": "2026-04-15T10:00:00.000Z",
 "scheduleTimezone": "Asia/Kolkata",
 "createdAt": "2026-04-10T09:00:00.000Z"
}

curl -X POST "https://slide.synquic.com/api/v1/whatsapp/campaigns/wac_01JXYZ/launch" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "status": "queued",
 "campaignId": "wac_01JXYZ..."
}

curl -X POST "https://slide.synquic.com/api/v1/whatsapp/campaigns/wac_01JXYZ/cancel" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "success": true,
 "campaignId": "wac_01JXYZ...",
 "refundedRecipients": 1240
}

curl -X POST https://slide.synquic.com/api/v1/sms/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "senderId": "ACMEIN",
 "to": ["919876543210", "919876543211"],
 "message": "Your order ORD-12345 has shipped. Track it at https://acme.com/track",
 "route": "transactional"
 }'

const res = await fetch('https://slide.synquic.com/api/v1/sms/send', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 senderId: 'ACMEIN',
 to: ['919876543210'],
 message: 'Your order ORD-12345 has shipped.',
 route: 'transactional',
 }),
});
const result = await res.json();
// { status: 'sent', recipients: 1, externalIds: ['ext_...'] }

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/sms/send',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'senderId': 'ACMEIN',
 'to': ['919876543210'],
 'message': 'Your order ORD-12345 has shipped.',
 'route': 'transactional',
 }
)
print(res.json())  # {'status': 'sent', 'recipients': 1, 'externalIds': ['ext_...']}

{
 "status": "sent",
 "recipients": 2,
 "externalIds": ["ext_01JXYZ...", "ext_02ABCD..."]
}

curl "https://slide.synquic.com/api/v1/sms/templates?page=1&limit=20&status=APPROVED" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "smst_01JXYZ...",
 "name": "Order Shipped",
 "dltTemplateId": "1107160000000012345",
 "body": "Your order {#var#} has shipped. Track it at {#var#}",
 "route": "transactional",
 "status": "APPROVED",
 "createdAt": "2026-02-01T09:00:00.000Z"
 }
 ],
 "meta": { "total": 8, "page": 1, "limit": 20, "totalPages": 1 }
}

curl "https://slide.synquic.com/api/v1/sms/senders?page=1&limit=20" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "smss_01JXYZ...",
 "senderId": "ACMEIN",
 "entityId": "1101230000000067890",
 "status": "APPROVED",
 "createdAt": "2026-01-20T09:00:00.000Z"
 }
 ],
 "meta": { "total": 2, "page": 1, "limit": 20, "totalPages": 1 }
}

curl "https://slide.synquic.com/api/v1/sms/campaigns?page=1&limit=20" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "smsc_01JXYZ...",
 "name": "Weekend Sale",
 "status": "COMPLETED",
 "route": "promotional",
 "senderId": "ACMEIN",
 "totalRecipients": 12000,
 "sentCount": 11940,
 "deliveredCount": 11512,
 "scheduledAt": null,
 "createdAt": "2026-03-28T09:00:00.000Z"
 }
 ],
 "meta": { "total": 4, "page": 1, "limit": 20, "totalPages": 1 }
}

curl "https://slide.synquic.com/api/v1/sms/campaigns/smsc_01JXYZ" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X POST https://slide.synquic.com/api/v1/sms/campaigns \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "name": "Weekend Sale",
 "messageBody": "Flat 20% off this weekend! Shop now: https://acme.com/sale",
 "senderId": "ACMEIN",
 "route": "promotional",
 "scheduledAt": "2026-04-12T04:30:00.000Z"
 }'

const res = await fetch('https://slide.synquic.com/api/v1/sms/campaigns', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 name: 'Weekend Sale',
 messageBody: 'Flat 20% off this weekend! Shop now: https://acme.com/sale',
 senderId: 'ACMEIN',
 route: 'promotional',
 }),
});
const campaign = await res.json();
// { id: 'smsc_01J...', status: 'DRAFT', ... }

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/sms/campaigns',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'name': 'Weekend Sale',
 'messageBody': 'Flat 20% off this weekend! Shop now: https://acme.com/sale',
 'senderId': 'ACMEIN',
 'route': 'promotional',
 }
)
campaign = res.json()
print(campaign['id'], campaign['status'])  # smsc_01J... DRAFT

{
 "id": "smsc_01JXYZ...",
 "name": "Weekend Sale",
 "status": "DRAFT",
 "route": "promotional",
 "senderId": "ACMEIN",
 "scheduledAt": "2026-04-12T04:30:00.000Z",
 "createdAt": "2026-04-10T09:00:00.000Z"
}

curl -X POST "https://slide.synquic.com/api/v1/sms/campaigns/smsc_01JXYZ/launch" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "status": "queued",
 "campaignId": "smsc_01JXYZ..."
}

curl -X POST "https://slide.synquic.com/api/v1/sms/campaigns/smsc_01JXYZ/cancel" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "success": true,
 "campaignId": "smsc_01JXYZ..."
}

curl "https://slide.synquic.com/api/v1/sms/logs?page=1&limit=50&direction=outbound&status=delivered" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "smsl_01JXYZ...",
 "externalId": "ext_01JXYZ...",
 "direction": "outbound",
 "route": "transactional",
 "status": "delivered",
 "body": "Your order ORD-12345 has shipped.",
 "senderId": "ACMEIN",
 "templateId": "smst_01JXYZ...",
 "source": "API",
 "sentAt": "2026-04-08T12:30:00.000Z",
 "deliveredAt": "2026-04-08T12:30:04.000Z",
 "failedAt": null,
 "errorCode": null,
 "errorMessage": null,
 "createdAt": "2026-04-08T12:30:00.000Z",
 "phone": "919876543210",
 "customerName": "John Doe"
 }
 ],
 "meta": { "total": 1420, "page": 1, "limit": 50, "totalPages": 29 }
}

curl "https://slide.synquic.com/api/v1/sms/stats?start=2026-04-01&end=2026-04-30" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "dataPoints": [
 { "date": "2026-04-01", "sent": 480, "delivered": 462, "failed": 18 },
 { "date": "2026-04-02", "sent": 512, "delivered": 498, "failed": 14 }
 ],
 "totals": {
 "sent": 992,
 "delivered": 960,
 "failed": 32,
 "deliveryRate": 96.77
 }
}

curl -X POST https://slide.synquic.com/api/v1/rcs/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "to": "919876543210",
 "templateId": "rcst_01JXYZ...",
 "rcsVariables": { "name": "John", "orderId": "ORD-12345" },
 "smsFallback": {
 "sender": "ACMEIN",
 "message": "Your order ORD-12345 has shipped.",
 "route": "transactional"
 },
 "ttl": "3600s"
 }'

const res = await fetch('https://slide.synquic.com/api/v1/rcs/send', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 to: '919876543210',
 templateId: 'rcst_01JXYZ...',
 rcsVariables: { name: 'John', orderId: 'ORD-12345' },
 smsFallback: { sender: 'ACMEIN', message: 'Your order ORD-12345 has shipped.' },
 }),
});
const result = await res.json();

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/rcs/send',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'to': '919876543210',
 'templateId': 'rcst_01JXYZ...',
 'rcsVariables': {'name': 'John', 'orderId': 'ORD-12345'},
 'smsFallback': {'sender': 'ACMEIN', 'message': 'Your order ORD-12345 has shipped.'},
 }
)
print(res.json())

curl "https://slide.synquic.com/api/v1/rcs/bots" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "rcsb_01JXYZ...",
 "name": "Acme Store",
 "status": "APPROVED",
 "createdAt": "2026-02-15T09:00:00.000Z"
 }
 ]
}

curl "https://slide.synquic.com/api/v1/rcs/templates?page=1&limit=20" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X POST https://slide.synquic.com/api/v1/rcs/campaigns \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "botId": "rcsb_01JXYZ...",
 "templateId": "rcst_01JXYZ...",
 "campaignName": "April Launch",
 "numbers": ["919876543210", "919876543211"],
 "country": "IN",
 "removeDuplicate": true,
 "fallback": true,
 "fallbackMessage": "New arrivals are live! Shop now: https://acme.com"
 }'

const res = await fetch('https://slide.synquic.com/api/v1/rcs/campaigns', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 botId: 'rcsb_01JXYZ...',
 templateId: 'rcst_01JXYZ...',
 campaignName: 'April Launch',
 numbers: ['919876543210', '919876543211'],
 removeDuplicate: true,
 }),
});
// 202 Accepted, bulk send queued

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/rcs/campaigns',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'botId': 'rcsb_01JXYZ...',
 'templateId': 'rcst_01JXYZ...',
 'campaignName': 'April Launch',
 'numbers': ['919876543210', '919876543211'],
 }
)
print(res.status_code)  # 202

curl "https://slide.synquic.com/api/v1/rcs/campaigns?page=1&limit=20" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl "https://slide.synquic.com/api/v1/rcs/logs?page=1&limit=50" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl "https://slide.synquic.com/api/v1/rcs/stats?start=2026-04-01&end=2026-04-30" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X POST https://slide.synquic.com/api/v1/otp/send \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{ "widgetId": "wgt_01JXYZ...", "identifier": "+919876543210" }'

const res = await fetch('https://slide.synquic.com/api/v1/otp/send', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({ widgetId: 'wgt_01JXYZ...', identifier: '+919876543210' }),
});
const { requestId } = await res.json();

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/otp/send',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={'widgetId': 'wgt_01JXYZ...', 'identifier': '+919876543210'}
)
request_id = res.json()['requestId']

{
 "requestId": "otpreq_01JXYZ..."
}

curl -X POST https://slide.synquic.com/api/v1/otp/retry \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{ "requestId": "otpreq_01JXYZ...", "channel": "whatsapp" }'

{
 "requestId": "otpreq_01JXYZ..."
}

curl -X POST https://slide.synquic.com/api/v1/otp/verify \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{ "requestId": "otpreq_01JXYZ...", "otp": "123456" }'

const res = await fetch('https://slide.synquic.com/api/v1/otp/verify', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({ requestId: 'otpreq_01JXYZ...', otp: '123456' }),
});
const { accessToken } = await res.json();
// Pass accessToken to your backend, then consume it with POST /otp/verify-token

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/otp/verify',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={'requestId': 'otpreq_01JXYZ...', 'otp': '123456'}
)
access_token = res.json()['accessToken']

{
 "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

curl -X POST https://slide.synquic.com/api/v1/otp/verify-token \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{ "accessToken": "eyJhbGciOiJIUzI1NiIs..." }'

{
 "verified": true,
 "identifier": "+919876543210",
 "verifiedAt": "2026-04-08T12:31:12.000Z"
}

curl "https://slide.synquic.com/api/v1/otp/logs?widgetId=wgt_01JXYZ&status=verified&page=1&limit=50" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "otpreq_01JXYZ...",
 "widgetId": "wgt_01JXYZ...",
 "identifier": "+919876543210",
 "channel": "sms",
 "status": "verified",
 "attempts": 1,
 "resends": 0,
 "sentAt": "2026-04-08T12:30:00.000Z",
 "verifiedAt": "2026-04-08T12:31:12.000Z"
 }
 ],
 "meta": { "total": 940, "page": 1, "limit": 50, "totalPages": 19 }
}

curl "https://slide.synquic.com/api/v1/otp/analytics?widgetId=wgt_01JXYZ" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "totalSent": 5230,
 "totalVerified": 4870,
 "totalExpired": 240,
 "totalBlocked": 46,
 "successRate": 93.12,
 "channelBreakdown": {
 "sms": { "sent": 4100, "verified": 3810 },
 "whatsapp": { "sent": 1130, "verified": 1060 }
 }
}

curl "https://slide.synquic.com/api/v1/shopify/products/search?q=sneakers&limit=5" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "gid://shopify/Product/123456",
 "title": "Classic Sneakers",
 "vendor": "Nike",
 "productType": "Footwear",
 "tags": ["sneakers", "sale"],
 "variants": [
 { "id": "gid://shopify/ProductVariant/789", "title": "Size 10", "price": "89.99", "inventoryQuantity": 24 }
 ]
 }
 ],
 "meta": { "count": 1, "query": "sneakers" }
}

curl "https://slide.synquic.com/api/v1/shopify/products/types" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": ["Accessories", "Footwear", "T-Shirts", "Watches"],
 "meta": { "count": 4 }
}

curl "https://slide.synquic.com/api/v1/shopify/products/gid://shopify/Product/123456" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl "https://slide.synquic.com/api/v1/shopify/collections" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 { "id": "gid://shopify/Collection/111", "title": "Summer Sale", "handle": "summer-sale", "productsCount": 24 }
 ],
 "meta": { "count": 1 }
}

curl "https://slide.synquic.com/api/v1/shopify/collections/gid://shopify/Collection/111/products?limit=10" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl "https://slide.synquic.com/api/v1/shopify/orders/status?identifier=%231001" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "orderNumber": "#1001",
 "financialStatus": "paid",
 "fulfillmentStatus": "fulfilled",
 "totalPrice": "129.99",
 "currency": "INR",
 "lineItems": [
 { "title": "Classic Sneakers", "quantity": 1, "price": "89.99" },
 { "title": "Sports Socks", "quantity": 2, "price": "20.00" }
 ],
 "tracking": {
 "carrier": "BlueDart",
 "number": "BD123456789",
 "url": "https://bluedart.com/track/BD123456789"
 },
 "createdAt": "2026-03-20T10:30:00.000Z"
}

curl "https://slide.synquic.com/api/v1/shopify/customers/orders?identifier=%2B919876543210" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const res = await fetch(
 'https://slide.synquic.com/api/v1/shopify/customers/orders?identifier=user@example.com',
 { headers: { 'Authorization': 'Bearer sk_live_YOUR_API_KEY' } }
);
const { customer, orders } = await res.json();

curl "https://slide.synquic.com/api/v1/shopify/discounts/validate?code=SAVE20" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "valid": true,
 "code": "SAVE20",
 "type": "percentage",
 "value": 20,
 "minimumOrderAmount": "500.00",
 "expiresAt": "2026-06-30T23:59:59.000Z",
 "usageCount": 142,
 "usageLimit": 1000
}

curl "https://slide.synquic.com/api/v1/voice/agents?page=1&limit=10" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "va_01JXYZ...",
 "name": "Sales Assistant",
 "description": "Handles inbound sales inquiries",
 "language": "en-US",
 "sttProvider": "DEEPGRAM",
 "ttsProvider": "ELEVENLABS",
 "llmProvider": "OPENAI",
 "llmModel": "gpt-4o-mini",
 "isActive": true,
 "createdAt": "2026-03-01T10:00:00.000Z"
 }
 ],
 "meta": { "total": 3, "page": 1, "limit": 10, "totalPages": 1 }
}

curl "https://slide.synquic.com/api/v1/voice/agents/va_01JXYZ" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl "https://slide.synquic.com/api/v1/voice/calls?status=COMPLETED&direction=OUTBOUND&limit=10" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": [
 {
 "id": "vc_01JXYZ...",
 "agentId": "va_01JXYZ...",
 "direction": "OUTBOUND",
 "callerNumber": "+911234567890",
 "calledNumber": "+919876543210",
 "status": "COMPLETED",
 "durationSeconds": 142,
 "sentiment": "POSITIVE",
 "summary": "Customer confirmed appointment for Thursday.",
 "wasConfirmed": true,
 "billedAmountPaise": 3200,
 "startedAt": "2026-03-24T10:00:00.000Z",
 "endedAt": "2026-03-24T10:02:22.000Z"
 }
 ],
 "meta": { "total": 56, "page": 1, "limit": 10, "totalPages": 6 }
}

curl -X POST "https://slide.synquic.com/api/v1/voice/calls/outbound" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "agentId": "va_01JXYZ...",
 "toNumber": "+919876543210",
 "callContext": {
 "customerName": "Rahul Sharma",
 "appointmentDate": "2026-04-10",
 "purpose": "appointment_confirmation"
 }
 }'

const res = await fetch('https://slide.synquic.com/api/v1/voice/calls/outbound', {
 method: 'POST',
 headers: {
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 body: JSON.stringify({
 agentId: 'va_01JXYZ...',
 toNumber: '+919876543210',
 callContext: { customerName: 'Rahul Sharma', purpose: 'appointment_confirmation' },
 }),
});

const call = await res.json();
// { id: 'vc_01J...', status: 'INITIATED', direction: 'OUTBOUND', ... }

import requests

res = requests.post(
 'https://slide.synquic.com/api/v1/voice/calls/outbound',
 headers={
 'Authorization': 'Bearer sk_live_YOUR_API_KEY',
 'Content-Type': 'application/json',
 },
 json={
 'agentId': 'va_01JXYZ...',
 'toNumber': '+919876543210',
 'callContext': {'customerName': 'Rahul Sharma', 'purpose': 'appointment_confirmation'},
 }
)
call = res.json()
print(call['id'], call['status']) # vc_01J... INITIATED

curl "https://slide.synquic.com/api/v1/voice/calls/vc_01JXYZ" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "id": "vc_01JXYZ...",
 "agentId": "va_01JXYZ...",
 "direction": "OUTBOUND",
 "status": "COMPLETED",
 "callerNumber": "+911234567890",
 "calledNumber": "+919876543210",
 "callerName": "Rahul Sharma",
 "durationSeconds": 142,
 "sentiment": "POSITIVE",
 "summary": "Customer confirmed the appointment for Thursday 10 AM.",
 "wasConfirmed": true,
 "wasBooked": false,
 "transcription": [
 { "role": "agent", "content": "Hello! This is a call from Acme Corp regarding your appointment.", "timestamp": "2026-03-24T10:00:03.000Z" },
 { "role": "user", "content": "Yes, I was expecting this call.", "timestamp": "2026-03-24T10:00:08.000Z" }
 ],
 "billedAmountPaise": 3200,
 "startedAt": "2026-03-24T10:00:00.000Z",
 "endedAt": "2026-03-24T10:02:22.000Z"
}

curl "https://slide.synquic.com/api/v1/voice/calls/vc_01JXYZ/recording" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "data": {
 "url": "https://s3.ap-south-1.amazonaws.com/recordings/vc_01JXYZ.ogg?X-Amz-Expires=3600&..."
 }
}

curl "https://slide.synquic.com/api/v1/voice/analytics?from=2026-03-01&to=2026-03-31" \
 -H "Authorization: Bearer sk_live_YOUR_API_KEY"

{
 "totalCalls": 234,
 "completedCalls": 198,
 "failedCalls": 12,
 "noAnswerCalls": 24,
 "avgDurationSeconds": 127,
 "totalDurationSeconds": 25146,
 "sentimentBreakdown": {
 "POSITIVE": 142,
 "NEUTRAL": 38,
 "NEGATIVE": 18
 },
 "totalCostPaise": 748800,
 "confirmedCount": 156,
 "bookedCount": 42
}

SETUP  (once per booking, from your backend)

  POST /v1/voice/app/identities        pro_991   role=PRO
  POST /v1/voice/app/identities        cust_5521 role=CUSTOMER
  POST /v1/voice/app/sessions          externalRef=BK-8842, pairs the two


OUTBOUND  (your Pro taps "Call")

  Pro app --> your backend --> POST /v1/voice/app/calls
                                { externalRef, fromExternalId: "pro_991" }
                          <-- { callId, roomId, token, voiceServerUrl }
  Pro app connects to voiceServerUrl with token (LiveKit client SDK)

  Meanwhile we notify the callee:
     webhook  voice.app.call.incoming  --> your backend  (always)
     push     to registered devices                      (if registered)
     socket   voice:app.call.incoming                    (if app foregrounded)


ANSWER

  Customer app --> your backend --> POST /v1/voice/app/calls/:id/accept
                                     { asExternalId: "cust_5521" }
                               <-- { token, voiceServerUrl }
  Customer app connects. Both are in the room. Connected.


END

  POST /v1/voice/app/calls/:id/end   { asExternalId }
  webhook voice.app.call.completed --> your backend

curl -X POST https://api.synquic.com/api/v1/voice/app/identities \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "externalId": "pro_991", "role": "PRO", "displayName": "Ramesh K." }' 

{
 "id": "vai_3c81",
 "externalId": "pro_991",
 "role": "PRO",
 "displayName": "Ramesh K.",
 "isActive": true,
 "lastSeenAt": "2026-08-22T10:09:00.000Z",
 "deviceCount": 2,
 "reachable": true
}

{
 "callId": "apc_7f31c9a2",
 "roomId": "app-org_1a2b-7f31c9a2",
 "status": "RINGING",
 "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
 "voiceServerUrl": "wss://livekit.synquic.com",
 "tokenExpiresIn": 300,
 "ringTimeoutSeconds": 45,
 "callee": { "externalId": "cust_5521", "displayName": "Priya S." }
}

{
 "id": "evt_01JXYZ...",
 "type": "voice.app.call.incoming",
 "createdAt": "2026-08-22T10:11:12.000Z",
 "data": {
 "callId": "apc_7f31c9a2",
 "sessionRef": "BK-8842",
 "roomId": "app-org_1a2b-7f31c9a2",
 "direction": "PRO_TO_CUSTOMER",
 "from": { "externalId": "pro_991", "displayName": "Ramesh K.", "role": "PRO" },
 "to": { "externalId": "cust_5521", "displayName": "Priya S.", "role": "CUSTOMER" },
 "ringTimeoutSeconds": 45,
 "startedAt": "2026-08-22T10:11:12.000Z"
 }
}

import { io } from 'socket.io-client';

const socket = io('https://slide.synquic.com', {
 transports: ['websocket'],
 autoConnect: true,
});

// Join your organization room to receive events
socket.emit('joinOrganization', 'your-org-id');

// Subscribe to a specific call for live transcript
socket.emit('joinCall', 'call-id');

// Unsubscribe when done
socket.emit('leaveCall', 'call-id');
socket.emit('leaveOrganization', 'your-org-id');

import socketio

sio = socketio.Client()
sio.connect('https://slide.synquic.com', transports=['websocket'])

# Join organization room
sio.emit('joinOrganization', 'your-org-id')

# Listen for events
@sio.on('voice:call.initiated')
def on_call_initiated(data):
 print(f"Call started: {data['callId']}")

@sio.on('voice:transcript.chunk')
def on_transcript(data):
 print(f"[{data['role']}]: {data['content']}")

// Listen for call lifecycle events
socket.on('voice:call.initiated', (data) => {
 console.log('Call started:', data.callId, data.direction);
});

socket.on('voice:call.answered', (data) => {
 console.log('Call answered:', data.callId);
 // Join call room for live transcript
 socket.emit('joinCall', data.callId);
});

socket.on('voice:call.ended', (data) => {
 console.log('Call ended:', data.callId, data.sentiment, data.summary);
 socket.emit('leaveCall', data.callId);
});

// Subscribe to live transcript for a specific call
socket.emit('joinCall', 'vc_01JXYZ...');

socket.on('voice:transcript.chunk', (chunk) => {
 const speaker = chunk.role === 'agent' ? 'AI' : 'Caller';
 console.log(`[${speaker}] ${chunk.content}`);
 // [AI] Hello! This is a call from Acme Corp regarding your appointment.
 // [Caller] Yes, I was expecting this call.
});

// Clean up when done
socket.emit('leaveCall', 'vc_01JXYZ...');

{
  "id": "evt_9f2c4b1e7a3d5f8c0b2e4a6d8f1c3e5a",
  "type": "contact.created",
  "createdAt": "2026-08-20T10:11:12.000Z",
  "accountId": "org_9f2c4b1e",
  "livemode": true,
  "data": {
    "contact": {
      "id": "ct_9f2c4b1e",
      "name": "Priya Sharma",
      "email": "priya@example.com",
      "phone": "+919876543210",
      "tags": ["newsletter"],
      "lifecycleStageId": "stg_lead",
      "createdAt": "2026-08-20T10:11:12.000Z"
    },
    "source": "widget"
  }
}

X-Slide-Signature: t=1755683472,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

const crypto = require('crypto');
const express = require('express');

const app = express();
const SECRET = process.env.SLIDE_WEBHOOK_SECRET; // whsec_...

// express.raw, NOT express.json — we need the exact bytes we were sent.
app.post('/webhooks/slide', express.raw({ type: 'application/json' }), (req, res) => {
  const header = req.get('X-Slide-Signature') || '';
  const rawBody = req.body.toString('utf8');

  const parts = Object.fromEntries(
    header.split(',').map((p) => {
      const i = p.indexOf('=');
      return [p.slice(0, i).trim(), p.slice(i + 1).trim()];
    }),
  );

  // Reject anything older than 5 minutes, so a captured delivery cannot be
  // replayed indefinitely. The timestamp is inside the signed string, so it
  // cannot be edited without breaking the signature.
  const drift = Math.abs(Math.floor(Date.now() / 1000) - Number(parts.t));
  if (!parts.t || drift > 300) return res.status(400).send('stale');

  const expected = crypto
    .createHmac('sha256', SECRET)
    .update(`${parts.t}.${rawBody}`, 'utf8')
    .digest();
  const received = Buffer.from(parts.v1 || '', 'hex');

  if (
    received.length !== expected.length ||
    !crypto.timingSafeEqual(received, expected)
  ) {
    return res.status(400).send('bad signature');
  }

  const event = JSON.parse(rawBody);

  // Acknowledge FIRST, then do the work. We time out after 10 seconds.
  res.sendStatus(200);

  handleEvent(event).catch(console.error);
});

import hashlib, hmac, time

def verify_slide_signature(raw_body: bytes, header: str, secret: str, tolerance: int = 300) -> bool:
    """raw_body must be the exact bytes received, never a re-serialised dict."""
    parts = dict(
        p.strip().split("=", 1) for p in header.split(",") if "=" in p
    )
    timestamp = parts.get("t")
    signature = parts.get("v1")
    if not timestamp or not signature:
        return False

    if abs(int(time.time()) - int(timestamp)) > tolerance:
        return False

    expected = hmac.new(
        secret.encode(),
        f"{timestamp}.".encode() + raw_body,
        hashlib.sha256,
    ).hexdigest()

    return hmac.compare_digest(expected, signature)