naftiko: 1.0.0-alpha2
info:
  label: Vonage Messaging and Notifications
  description: Unified messaging workflow combining Vonage SMS API and Messages API for sending notifications, alerts, and
    multi-channel communications to customers. Used by developers building notification systems, customer engagement platforms,
    and omnichannel messaging applications.
  tags:
  - Communication
  - Messaging
  - Notifications
  - Omnichannel
  - SMS
  - WhatsApp
  - Vonage
  created: '2026-05-03'
  modified: '2026-05-06'
binds:
- namespace: env
  keys:
    VONAGE_API_KEY: VONAGE_API_KEY
    VONAGE_API_SECRET: VONAGE_API_SECRET
    VONAGE_JWT_TOKEN: VONAGE_JWT_TOKEN
capability:
  consumes:
  - type: http
    namespace: vonage-sms
    baseUri: https://rest.nexmo.com
    description: Vonage SMS API for sending text messages globally.
    authentication:
      type: apikey
      key: api_key
      value: '{{VONAGE_API_KEY}}'
      placement: body
    resources:
    - name: sms
      path: /sms/json
      description: Send outbound SMS messages.
      operations:
      - name: send-sms
        method: POST
        description: Send an SMS message to a recipient.
        inputParameters:
        - name: to
          in: body
          type: string
          required: true
          description: Recipient phone number in E.164 format.
        - name: from
          in: body
          type: string
          required: true
          description: Sender phone number or alphanumeric name.
        - name: text
          in: body
          type: string
          required: true
          description: The SMS message body.
        - name: type
          in: body
          type: string
          required: false
          description: 'Message type: text, binary, or unicode.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  - type: http
    namespace: vonage-messages
    baseUri: https://api.nexmo.com
    description: Vonage Messages API for multi-channel messaging.
    authentication:
      type: bearer
      token: '{{VONAGE_JWT_TOKEN}}'
    resources:
    - name: messages
      path: /v1/messages
      description: Send messages across channels.
      operations:
      - name: send-message
        method: POST
        description: Send a message to a given channel.
        inputParameters:
        - name: message_type
          in: body
          type: string
          required: true
          description: Message type (text, image, audio, video, file, template).
        - name: to
          in: body
          type: string
          required: true
          description: Recipient phone number or ID.
        - name: from
          in: body
          type: string
          required: true
          description: Sender number or ID.
        - name: channel
          in: body
          type: string
          required: true
          description: Channel (sms, whatsapp, messenger, viber_service, mms, rcs).
        - name: text
          in: body
          type: string
          required: false
          description: Message text for text messages.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: message
      path: /v1/messages/{message_uuid}
      description: Update message status.
      operations:
      - name: update-message
        method: PATCH
        description: Update the status of a message (e.g., mark as read).
        inputParameters:
        - name: message_uuid
          in: path
          type: string
          required: true
          description: The message UUID.
        - name: status
          in: body
          type: string
          required: true
          description: New status (read).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: vonage-messaging-api
    description: Unified REST API for Vonage messaging and notifications.
    resources:
    - path: /v1/sms
      name: sms-messages
      description: Send SMS messages via legacy SMS API.
      operations:
      - method: POST
        name: send-sms
        description: Send an SMS message to a recipient.
        call: vonage-sms.send-sms
        with:
          to: rest.to
          from: rest.from
          text: rest.text
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messages
      name: channel-messages
      description: Send messages via any supported channel (WhatsApp, Messenger, Viber, RCS, MMS, SMS).
      operations:
      - method: POST
        name: send-message
        description: Send a message via the unified Messages API.
        call: vonage-messages.send-message
        with:
          message_type: rest.message_type
          to: rest.to
          from: rest.from
          channel: rest.channel
          text: rest.text
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: vonage-messaging-mcp
    transport: http
    description: MCP server for AI-assisted multi-channel messaging with Vonage.
    tools:
    - name: send-sms
      description: Send an SMS text message to a phone number.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vonage-sms.send-sms
      with:
        to: tools.to
        from: tools.from
        text: tools.text
      outputParameters:
      - type: object
        mapping: $.
    - name: send-whatsapp-message
      description: Send a WhatsApp message to a phone number.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vonage-messages.send-message
      with:
        message_type: text
        channel: whatsapp
        to: tools.to
        from: tools.from
        text: tools.text
      outputParameters:
      - type: object
        mapping: $.
    - name: send-rcs-message
      description: Send an RCS rich message to a phone number.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vonage-messages.send-message
      with:
        message_type: text
        channel: rcs
        to: tools.to
        from: tools.from
        text: tools.text
      outputParameters:
      - type: object
        mapping: $.
    - name: send-viber-message
      description: Send a Viber service message to a phone number.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vonage-messages.send-message
      with:
        message_type: text
        channel: viber_service
        to: tools.to
        from: tools.from
        text: tools.text
      outputParameters:
      - type: object
        mapping: $.