# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Matomo Reporting API for plugin Mobile Messaging API
  version: 1.0.0
extends: openapi/matomo-mobilemessaging-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/index.php?module=API&method=MobileMessaging.areSMSAPICredentialProvided'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether SMS credentials are set
      effect: read
      questions:
      - Have I configured SMS API credentials yet for text alerts?
      - Is SMS sending set up for my account?
      instructions:
      - text: Check whether SMS API credentials are configured for me.
      - text: Tell me if my SMS provider credentials are in place.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.getSMSProvider'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the configured SMS provider
      effect: read
      questions:
      - Which SMS provider is my account using for text messages?
      - What SMS gateway did I configure?
      instructions:
      - text: Show which SMS provider is configured for my account.
      - text: Get the name of my current SMS provider.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.setSMSAPICredential'].get
  update:
    x-apievangelist-phrasing:
      intent: Save SMS provider credentials
      effect: write
      questions:
      - How do I connect an SMS provider so Matomo can text me reports?
      - Can I change the API credentials for my SMS gateway?
      instructions:
      - text: Set my SMS provider to {provider} with credentials {credentials}.
        slots:
          provider: query.provider
          credentials: query.credentials
      - text: Save SMS API credentials for provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.addPhoneNumber'].get
  update:
    x-apievangelist-phrasing:
      intent: Add a phone number for SMS
      effect: write
      questions:
      - How do I add my mobile number to receive SMS reports?
      - Will I get a verification code when I add a phone number?
      instructions:
      - text: Add phone number {phoneNumber} and send it a verification code.
        slots:
          phoneNumber: query.phoneNumber
      - text: Register {phoneNumber} as a mobile number on my account.
        slots:
          phoneNumber: query.phoneNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.resendVerificationCode'].get
  update:
    x-apievangelist-phrasing:
      intent: Resend a phone verification code
      effect: write
      questions:
      - I never got the SMS verification code, can it be sent again?
      - How do I request a new code for a phone number still pending verification?
      instructions:
      - text: Resend the verification code to {phoneNumber}.
        slots:
          phoneNumber: query.phoneNumber
      - text: Send a fresh verification code to pending number {phoneNumber}.
        slots:
          phoneNumber: query.phoneNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.getCreditLeft'].get
  update:
    x-apievangelist-phrasing:
      intent: Check remaining SMS credit
      effect: read
      questions:
      - How much SMS credit do I have left?
      - Am I about to run out of text message credit?
      instructions:
      - text: Show my remaining SMS credit.
      - text: Check how much credit is left on my SMS provider account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.getPhoneNumbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List my phone numbers
      effect: read
      questions:
      - Which phone numbers are set up on my account for SMS?
      - Are my mobile numbers verified yet?
      instructions:
      - text: List the phone numbers on my account.
      - text: Show all my configured mobile numbers and their verification state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.removePhoneNumber'].get
  update:
    x-apievangelist-phrasing:
      intent: Remove a phone number
      effect: destructive
      questions:
      - How do I stop SMS going to an old phone number?
      - Can I delete a mobile number from my account?
      instructions:
      - text: Remove phone number {phoneNumber} from my account.
        slots:
          phoneNumber: query.phoneNumber
      - text: Delete {phoneNumber} so it no longer receives SMS.
        slots:
          phoneNumber: query.phoneNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.validatePhoneNumber'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a phone number with its code
      effect: write
      questions:
      - How do I confirm my phone number with the code I was texted?
      - Where do I enter the SMS verification code?
      instructions:
      - text: Verify {phoneNumber} with code {verificationCode}.
        slots:
          phoneNumber: query.phoneNumber
          verificationCode: query.verificationCode
      - text: Confirm phone number {phoneNumber} using verification code {verificationCode}.
        slots:
          phoneNumber: query.phoneNumber
          verificationCode: query.verificationCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.deleteSMSAPICredential'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete the SMS provider credentials
      effect: destructive
      questions:
      - How do I disconnect my SMS provider and remove its credentials?
      - Can I wipe the stored SMS API key?
      instructions:
      - text: Delete my SMS API credentials.
      - text: Remove the stored SMS provider credentials.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.setDelegatedManagement'].get
  update:
    x-apievangelist-phrasing:
      intent: Allow users to manage their own SMS setup
      effect: write
      questions:
      - Can regular users set up their own SMS credentials instead of the admin?
      - How do I turn on delegated SMS management?
      instructions:
      - text: Set delegated SMS management to {delegatedManagement}.
        slots:
          delegatedManagement: query.delegatedManagement
      - text: 'Let regular users manage their own SMS API credentials: {delegatedManagement}.'
        slots:
          delegatedManagement: query.delegatedManagement
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MobileMessaging.getDelegatedManagement'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if SMS management is delegated
      effect: read
      questions:
      - Are regular users allowed to manage their own SMS credentials?
      - Is delegated SMS management turned on?
      instructions:
      - text: Check whether SMS management is delegated to users.
      - text: Tell me if regular users can manage their own SMS settings.
      method: generated
      generated: '2026-10-01'