Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Sms Events API

5 actions 5 updates phrasing extends openapi/leadping-smsevents-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Leadping's API. It is a proposal applied on top of the contract, not a document Leadping publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/events/sms/all/my'].post

$.paths['/events/sms/{smsEventId}'].get

$.paths['/events/sms/lead/{leadId}'].post

$.paths['/events/sms/phone/{phoneNumber}'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Leadping Sms Events API
  version: 1.0.0
extends: openapi/leadping-smsevents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/events/sms/all/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List my SMS history
      effect: read
      questions:
      - What text messages have I sent and received across all leads?
      - Can I search my SMS history?
      instructions:
      - text: List all my SMS events.
      - text: Search my text message history for {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/sms/{smsEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS event
      effect: read
      questions:
      - How do I check the delivery status of one text message?
      - Which lead was a specific SMS sent to?
      instructions:
      - text: Show SMS event {smsEventId}.
        slots:
          smsEventId: path.smsEventId
      - text: Get the delivery status of text {smsEventId}.
        slots:
          smsEventId: path.smsEventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/sms/lead/{leadId}'].post
  update:
    x-apievangelist-phrasing:
      intent: List text messages for a lead
      effect: read
      questions:
      - What texts have gone to a particular lead, including scheduled ones?
      - Can I review message delivery outcomes for one lead?
      instructions:
      - text: List SMS events for lead {leadId}.
        slots:
          leadId: path.leadId
      - text: Show sent and scheduled texts for lead {leadId}.
        slots:
          leadId: path.leadId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/sms/phone/{phoneNumber}'].post
  update:
    x-apievangelist-phrasing:
      intent: List SMS events for a phone number
      effect: read
      questions:
      - How much texting has one phone number done?
      - Can I see the delivery outcomes for messages on a given number?
      instructions:
      - text: List SMS events for phone number {phoneNumber}.
        slots:
          phoneNumber: path.phoneNumber
      - text: Show text volume and delivery results for {phoneNumber}.
        slots:
          phoneNumber: path.phoneNumber
      method: generated
      generated: '2026-09-26'