VUZDevelopers

Send document via SMS

POST
/documents/{id}/share/sms

Sends a document to a recipient via SMS with a short link to view the PDF.

Message Format: "קיבלת {סוג מסמך} מ{שם העסק}. לצפייה: {קישור}"

With payment link: "קיבלת {סוג מסמך} מ{שם העסק}. לצפייה: {קישור} לתשלום: {קישור תשלום}"

Billing:

  • 0.15 ILS per SMS segment
  • Hebrew messages: ~70 chars per segment
  • Total message limited to 201 chars (3 segments max)
  • Charges added to monthly bill

Requirements:

  • Active subscription with valid payment method
  • Israeli mobile phone number (05xxxxxxxx format)

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Document ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/documents/550e8400-e29b-41d4-a716-446655440000/share/sms" \  -H "Content-Type: application/json" \  -d '{    "recipientPhone": "0527253023"  }'
{  "success": true,  "message": "SMS sent successfully",  "shareUrl": "https://vuz.co.il/r/abc123",  "smsSentAt": "2025-12-07T10:30:00.000Z",  "smsMessageId": "550e8400-e29b-41d4-a716-446655440000",  "segmentCount": 1,  "cost": 0.15,  "paymentLinkUrl": "https://vuz.co.il/pay/xyz789",  "paymentLinkId": "pl_abc123xyz"}