SMS and WhatsApp Messaging

{'type': 'object', 'required': ['recipient_id', 'content'], 'properties': {'channel': {'enum': ['sms', 'email', 'voice'], 'type': 'string', 'description': "Delivery channel. Omit to auto-infer sms/email from recipient_id; set 'voice'…"}, 'content': {'type': 'string', 'description': 'The actual message body you intend to send. The gate classifies the real text,…'}, 'state_code': {'type': 'string', 'description': "US state code (e.g. 'CA') for state-specific rules."}, 'country_code': {'type': 'string', 'description': "ISO 3166-1 alpha-2 (e.g. 'US', 'DE', 'CA'). Auto-inferred from phone if…"}, 'message_type': {'type': 'string', 'default': 'transactional', 'description': 'Intent tag: transactional, marketing, reminder, follow_up, notification.…'}, 'recipient_id': {'type': 'string', 'description': "Phone in E.164 (e.g. '+14045550100') or email address the message would go to."}}}

{'type': 'object', 'required': ['vertical', 'location'], 'properties': {'city': {'type': 'string', 'description': 'Alternative to location: a top-level city, normalised into…'}, 'region': {'type': 'string', 'description': 'Alternative to location: a top-level state/region, normalised into…'}, 'location': {'type': 'object', 'required': ['zip_or_city'], 'properties': {'zip_or_city': {'type': 'string', 'description': "City, town, address or postal code, optionally with the country, e.g. 'Nizwa, Oman'. A bare 5-digit ZIP is read as a US ZIP; give any non-US postal code with its country (e.g. '10115, Germany')."}, 'radius_miles': {'type': 'number', 'minimum': 0, 'description': 'Radius in miles (default 3.1, max 25); applies to OpenStreetMap results only.'}}, 'description': "City/town or ZIP, optionally with country ('Nizwa, Oman'). Geocoded by OSM."}, 'vertical': {'enum': ['personal_services', 'home_services', 'professional_services'], 'type': 'string'}, 'capability': {'type': 'string', 'description': "Kind of business, e.g. 'haircut', 'plumber', 'dentist'. Mapped to OSM tags."}, 'price_band': {'type': 'object', 'properties': {'max_usd': {'type': 'number'}}, 'description': 'Supply-network rows only; OpenStreetMap has no prices.'}, 'max_results': {'type': 'integer', 'default': 5, 'maximum': 20, 'minimum': 1}, 'availability_window': {'type': 'object', 'properties': {'end_iso': {'type': 'string', 'format': 'date-time'}, 'start_iso': {'type': 'string', 'format': 'date-time'}}, 'description': 'Accepted but NOT APPLIED - it does not narrow results. We do not hold live…'}}}

{'type': 'object', 'properties': {'reference': {'type': 'string', 'description': "The 4-digit request reference, e.g. '4821'. Requires business_number."}, 'business_number': {'type': 'string', 'description': 'Scopes a `reference` to one business (references are reused across businesses).'}, 'conversation_id': {'type': 'string', 'description': 'From the send_message receipt (preferred).'}}}

{'type': 'object', 'required': ['operation_id'], 'properties': {'operation_id': {'type': 'string'}}}

{'type': 'object', 'required': ['operation_id'], 'properties': {'operation_id': {'type': 'string'}}}

{'type': 'object', 'required': ['operation', 'params'], 'properties': {'params': {'type': 'object', 'description': 'The same request body you would pass to the operation'}, 'operation': {'type': 'string'}}}

{'type': 'object', 'properties': {}}

{'type': 'object', 'required': ['recipient', 'message_type', 'content'], 'properties': {'content': {'type': 'object', 'required': ['body'], 'properties': {'body': {'type': 'string'}, 'subject': {'type': 'string', 'description': 'For email channel'}, 'template_id': {'type': 'string'}, 'template_vars': {'type': 'object'}}}, 'recipient': {'type': 'object', 'required': ['id_type', 'id_value'], 'properties': {'id_type': {'enum': ['phone', 'email', 'smb_id', 'customer_id'], 'type': 'string'}, 'id_value': {'type': 'string'}, 'country_code': {'type': 'string', 'description': 'ISO 3166-1 alpha-2, required for compliance routing'}}}, 'business_id': {'type': 'string', 'description': 'Stable id for the recipient business; used for global demand shaping.'}, 'message_type': {'enum': ['transactional', 'marketing', 'reminder', 'follow_up', 'notification'], 'type': 'string', 'description': "Intent tag for the message. Five permitted types. 'marketing' is allowed only…"}, 'on_behalf_of': {'type': 'string', 'description': "Who this message is FOR (your end-user's name/label). On WhatsApp this opens a…"}, 'idempotency_key': {'type': 'string', 'maxLength': 128, 'description': 'Retry key: a 24h replay returns the original receipt, not re-run or charged.'}, 'preferred_channel': {'enum': ['whatsapp', 'sms', 'email', 'voice', 'auto'], 'type': 'string', 'default': 'auto'}}}

{'type': 'object', 'required': ['recipient', 'confirmation_type', 'data'], 'properties': {'data': {'type': 'object', 'description': 'Type-specific payload; e.g., {otp_code} for otp, {appointment_time, smb_name}…'}, 'recipient': {'type': 'object', 'required': ['phone_or_email'], 'properties': {'name': {'type': 'string'}, 'phone_or_email': {'type': 'string'}}}, 'idempotency_key': {'type': 'string', 'maxLength': 128, 'description': 'Retry key: a 24h replay returns the original receipt, not re-run or charged.'}, 'confirmation_type': {'enum': ['otp', 'booking_confirmation', 'payment_receipt', 'cancellation_notice', 'reminder'], 'type': 'string'}, 'preferred_channel': {'enum': ['sms', 'email', 'auto'], 'type': 'string', 'default': 'sms'}}}

{'type': 'object', 'required': ['smb_id'], 'properties': {'smb_id': {'type': 'string'}, 'capability_to_verify': {'type': 'string'}}}