GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 SMS Messages API

5 actions 5 updates phrasing extends openapi/getresponse-sms-messages-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/sms/{smsId}'].get
$.paths['/sms'].get
$.paths['/sms'].post
$.paths['/sms/sender-names'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 SMS Messages API
  version: 1.0.0
extends: openapi/getresponse-sms-messages-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['/sms/{smsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS message
      effect: read
      questions:
      - What content and sending status does one SMS message have?
      - Can I look up a single SMS by its ID?
      instructions:
      - text: Show SMS message {smsId}.
        slots:
          smsId: path.smsId
      - text: Get the content and sending status of SMS {smsId}.
        slots:
          smsId: path.smsId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS messages
      effect: read
      questions:
      - Which SMS messages have I sent or scheduled?
      - Can I sort my SMS messages by clicks or deliveries?
      instructions:
      - text: List all my SMS messages.
      - text: Show SMS messages with sending status {sendingStatus}.
        slots:
          sendingStatus: query.query[sendingStatus]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS message
      effect: write
      questions:
      - How do I send a text message to my contacts?
      - What recipient types can an SMS go to?
      instructions:
      - text: Send an SMS named {name} saying {content} to {recipientsType} recipients.
        slots:
          name: requestBody.name
          content: requestBody.content
          recipientsType: requestBody.recipientsType
      - text: Text {recipientsType} recipients the message {content} as SMS {name}.
        slots:
          recipientsType: requestBody.recipientsType
          content: requestBody.content
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/sender-names'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS sender names
      effect: read
      questions:
      - Which sender names can I use for text messages?
      - Can I see only approved SMS sender names?
      instructions:
      - text: List my SMS sender names.
      - text: Show SMS sender names with status {status}.
        slots:
          status: query.query[status]
      method: generated
      generated: '2026-09-26'