naftiko: 1.0.0-alpha2
info:
  label: Sinch Omnichannel Messaging
  description: Unified omnichannel messaging workflow combining SMS batch messaging and Conversation API for multi-channel
    delivery across SMS, WhatsApp, RCS, Facebook Messenger, Viber, Telegram, and more. Used by marketing teams, customer engagement
    platforms, and notification services needing to reach customers on their preferred channel.
  tags:
  - Messaging
  - SMS
  - Omnichannel
  - WhatsApp
  - Conversation
  created: '2026-05-02'
  modified: '2026-05-06'
binds:
- namespace: env
  keys:
    SINCH_API_TOKEN: SINCH_API_TOKEN
    SINCH_SERVICE_PLAN_ID: SINCH_SERVICE_PLAN_ID
    SINCH_PROJECT_ID: SINCH_PROJECT_ID
capability:
  consumes:
  - type: http
    namespace: sinch-sms
    baseUri: https://us.sms.api.sinch.com
    description: Sinch SMS API for global messaging
    authentication:
      type: bearer
      token: '{{SINCH_API_TOKEN}}'
    resources:
    - name: batches
      path: /xms/v1/{service_plan_id}/batches
      description: Send and manage SMS batches
      operations:
      - name: send-batch
        method: POST
        description: Send a batch SMS message to one or more recipients
        inputParameters:
        - name: service_plan_id
          in: path
          type: string
          required: true
          description: The service plan ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            from: '{{tools.from}}'
            to: '{{tools.to}}'
            body: '{{tools.body}}'
      - name: list-batches
        method: GET
        description: List SMS batches
        inputParameters:
        - name: service_plan_id
          in: path
          type: string
          required: true
          description: The service plan ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: delivery-reports
      path: /xms/v1/{service_plan_id}/batches/{batch_id}/delivery_report
      description: Retrieve delivery reports for SMS batches
      operations:
      - name: get-batch-delivery-report
        method: GET
        description: Retrieve a batch delivery report
        inputParameters:
        - name: service_plan_id
          in: path
          type: string
          required: true
          description: The service plan ID
        - name: batch_id
          in: path
          type: string
          required: true
          description: The batch identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: inbound-messages
      path: /xms/v1/{service_plan_id}/inbounds
      description: Retrieve inbound SMS messages
      operations:
      - name: list-inbound-messages
        method: GET
        description: List inbound SMS messages
        inputParameters:
        - name: service_plan_id
          in: path
          type: string
          required: true
          description: The service plan ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  - type: http
    namespace: sinch-conversation
    baseUri: https://us.conversation.api.sinch.com
    description: Sinch Conversation API for omnichannel messaging
    authentication:
      type: bearer
      token: '{{SINCH_API_TOKEN}}'
    resources:
    - name: messages
      path: /v1/projects/{project_id}/messages
      description: Send and manage messages across channels
      operations:
      - name: send-message
        method: POST
        description: Send a message across any supported channel
        inputParameters:
        - name: project_id
          in: path
          type: string
          required: true
          description: The Sinch project identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            app_id: '{{tools.app_id}}'
            recipient: '{{tools.recipient}}'
            message: '{{tools.message}}'
      - name: list-messages
        method: GET
        description: List messages
        inputParameters:
        - name: project_id
          in: path
          type: string
          required: true
          description: The Sinch project identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: contacts
      path: /v1/projects/{project_id}/contacts
      description: Manage conversation contacts
      operations:
      - name: create-contact
        method: POST
        description: Create a new contact
        inputParameters:
        - name: project_id
          in: path
          type: string
          required: true
          description: The Sinch project identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        body:
          type: json
          data:
            channel_identities: '{{tools.channel_identities}}'
            display_name: '{{tools.display_name}}'
      - name: list-contacts
        method: GET
        description: List contacts
        inputParameters:
        - name: project_id
          in: path
          type: string
          required: true
          description: The Sinch project identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: conversations
      path: /v1/projects/{project_id}/conversations
      description: Manage conversation threads
      operations:
      - name: list-conversations
        method: GET
        description: List conversations
        inputParameters:
        - name: project_id
          in: path
          type: string
          required: true
          description: The Sinch project identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: omnichannel-messaging-api
    description: Unified REST API for Sinch omnichannel messaging workflows.
    resources:
    - path: /v1/sms/batches
      name: sms-batches
      description: Send SMS messages in bulk
      operations:
      - method: POST
        name: send-sms-batch
        description: Send a batch SMS message to multiple recipients
        call: sinch-sms.send-batch
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: list-sms-batches
        description: List sent SMS batches
        call: sinch-sms.list-batches
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sms/inbounds
      name: sms-inbound
      description: Retrieve received SMS messages
      operations:
      - method: GET
        name: list-inbound-sms
        description: List inbound SMS messages
        call: sinch-sms.list-inbound-messages
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/messages
      name: messages
      description: Send omnichannel messages via Conversation API
      operations:
      - method: POST
        name: send-message
        description: Send a message via any supported channel
        call: sinch-conversation.send-message
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: list-messages
        description: List sent and received messages
        call: sinch-conversation.list-messages
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contacts
      name: contacts
      description: Manage messaging contacts
      operations:
      - method: POST
        name: create-contact
        description: Create a new contact
        call: sinch-conversation.create-contact
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: list-contacts
        description: List contacts
        call: sinch-conversation.list-contacts
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/conversations
      name: conversations
      description: Manage conversation threads
      operations:
      - method: GET
        name: list-conversations
        description: List conversation threads
        call: sinch-conversation.list-conversations
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: omnichannel-messaging-mcp
    transport: http
    description: MCP server for AI-assisted omnichannel messaging and customer engagement.
    tools:
    - name: send-sms
      description: Send a batch SMS message to one or more phone numbers
      hints:
        readOnly: false
        destructive: false
      call: sinch-sms.send-batch
      with:
        from: tools.from
        to: tools.to
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-sms-batches
      description: List sent SMS batches with delivery status
      hints:
        readOnly: true
        openWorld: true
      call: sinch-sms.list-batches
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sms-delivery-report
      description: Get delivery report for an SMS batch
      hints:
        readOnly: true
        openWorld: false
      call: sinch-sms.get-batch-delivery-report
      outputParameters:
      - type: object
        mapping: $.
    - name: list-inbound-sms
      description: List received inbound SMS messages
      hints:
        readOnly: true
        openWorld: true
      call: sinch-sms.list-inbound-messages
      outputParameters:
      - type: object
        mapping: $.
    - name: send-omnichannel-message
      description: Send a message via WhatsApp, RCS, Facebook Messenger, Viber, or other channels
      hints:
        readOnly: false
        destructive: false
      call: sinch-conversation.send-message
      with:
        app_id: tools.app_id
        recipient: tools.recipient
        message: tools.message
      outputParameters:
      - type: object
        mapping: $.
    - name: list-messages
      description: List sent and received messages across all channels
      hints:
        readOnly: true
        openWorld: true
      call: sinch-conversation.list-messages
      outputParameters:
      - type: object
        mapping: $.
    - name: create-contact
      description: Create a new omnichannel contact
      hints:
        readOnly: false
        destructive: false
      call: sinch-conversation.create-contact
      outputParameters:
      - type: object
        mapping: $.
    - name: list-contacts
      description: List messaging contacts
      hints:
        readOnly: true
        openWorld: true
      call: sinch-conversation.list-contacts
      outputParameters:
      - type: object
        mapping: $.
    - name: list-conversations
      description: List conversation threads across channels
      hints:
        readOnly: true
        openWorld: true
      call: sinch-conversation.list-conversations
      outputParameters:
      - type: object
        mapping: $.