Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Sms API

4 actions 4 updates phrasing extends openapi/leadping-sms-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 4

$.info

$.paths['/sms/send'].post

$.paths['/sms/media'].post

$.paths['/sms/{smsEventId}/cancel'].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 API
  version: 1.0.0
extends: openapi/leadping-sms-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: 3
- target: $.paths['/sms/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a text message to a lead
      effect: write
      questions:
      - How do I text a lead from Leadping?
      - Can I schedule an SMS to go out later?
      - Is it possible to attach images to make it an MMS?
      instructions:
      - text: 'Text conversation {conversationId}: {text}.'
        slots:
          conversationId: requestBody.conversationId
          text: requestBody.text
      - text: Schedule the message "{text}" in conversation {conversationId} for {scheduledFor}.
        slots:
          text: requestBody.text
          conversationId: requestBody.conversationId
          scheduledFor: requestBody.scheduledFor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/media'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an MMS attachment
      effect: write
      questions:
      - How do I upload an image to include in an MMS?
      - What happens to a media file before it can be attached to a text?
      instructions:
      - text: Upload {file} as an MMS attachment.
        slots:
          file: requestBody.file
      - text: 'Upload this picture for my next picture message: {file}.'
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/{smsEventId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled text
      effect: destructive
      questions:
      - How do I stop a scheduled text before it's delivered?
      - Until when can I still cancel a queued SMS?
      instructions:
      - text: Cancel scheduled SMS {smsEventId}.
        slots:
          smsEventId: path.smsEventId
      - text: Stop queued message {smsEventId} from sending.
        slots:
          smsEventId: path.smsEventId
      method: generated
      generated: '2026-09-26'