> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Reputation-scan URLs in a draft message (anti-smishing)

> Scans every URL in a draft message body against URL/link-reputation heuristics (phishing/malware/smishing) without sending. Used by compose dialogs to flag dangerous destination links before send. Read-only and advisory — it sends nothing, routes nothing, and enforces nothing; the caller decides what to do with the verdict. Rate-limited to 120 requests/minute per tenant.



## OpenAPI

````yaml /openapi.yaml post /api/v1/messages/url-scan
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/messages/url-scan:
    post:
      tags:
        - Messages
      summary: Reputation-scan URLs in a draft message (anti-smishing)
      description: >-
        Scans every URL in a draft message body against URL/link-reputation
        heuristics (phishing/malware/smishing) without sending. Used by compose
        dialogs to flag dangerous destination links before send. Read-only and
        advisory — it sends nothing, routes nothing, and enforces nothing; the
        caller decides what to do with the verdict. Rate-limited to 120
        requests/minute per tenant.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  maxLength: 10000
                  default: ''
                  description: >-
                    Draft message body to scan for URLs. URL-free bodies return
                    an empty, clean verdict.
      responses:
        '200':
          description: Aggregate reputation verdict for the draft body
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: >-
                      Aggregate reputation verdict — the body-level score is the
                      worst per-URL score.
                    properties:
                      url_count:
                        type: integer
                        description: Number of distinct URLs found and analyzed.
                      score:
                        type: integer
                        minimum: 0
                        maximum: 100
                        description: >-
                          Worst per-URL composite score across the body (0 clean
                          → 100 block).
                      band:
                        type: string
                        enum:
                          - clean
                          - suspicious
                          - malicious
                        description: Coarse band derived from the worst-URL score.
                      recommendation:
                        type: string
                        enum:
                          - allow
                          - review
                          - block
                        description: >-
                          Advisory action suggested by the scan — the endpoint
                          enforces nothing.
                      urls:
                        type: array
                        description: Per-URL breakdowns, ordered worst-score first.
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              description: The exact URL as it appeared in the body.
                            host:
                              type:
                                - 'null'
                                - string
                              description: >-
                                The lower-cased host analyzed, or null if the
                                URL was unparseable.
                            score:
                              type: integer
                              minimum: 0
                              maximum: 100
                              description: >-
                                Transparent composite score for this URL (0
                                clean → 100 block).
                            band:
                              type: string
                              enum:
                                - clean
                                - suspicious
                                - malicious
                            findings:
                              type: array
                              description: >-
                                Per-signal breakdown that sums (pre-cap) into
                                the URL score.
                              items:
                                type: object
                                properties:
                                  code:
                                    type: string
                                    description: Machine-readable signal identifier.
                                  severity:
                                    type: string
                                    enum:
                                      - info
                                      - warn
                                      - block
                                  points:
                                    type: integer
                                    description: >-
                                      Points this signal contributed to the URL
                                      score.
                                  detail:
                                    type: string
                                    description: Human-readable explanation of the signal.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: >-
                          Unique request identifier (also returned in
                          X-Request-Id header)
                      timestamp:
                        type: string
                        format: date-time
                        description: ISO 8601 UTC timestamp of the response
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````