SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Telephony API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/telephony/calls/get-list'].post
$.paths['/contacts/{contactId}/get-calls'].post
$.paths['/deals/{dealId}/get-calls'].post
$.paths['/deals/{dealId}/attach-call'].post

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 SendPulse CRM Public Telephony API
  version: 1.0.0
extends: openapi/sendpulse-telephony-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: 4
- target: $.paths['/telephony/calls/get-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search all telephony calls
      effect: read
      questions:
      - Which calls came in across my whole account last week?
      - Can I filter all calls by type, state or responsible manager?
      instructions:
      - text: List all calls between {from} and {to}.
        slots:
          from: requestBody.from
          to: requestBody.to
      - text: Find account-wide calls with the phone number {contactPhone}.
        slots:
          contactPhone: requestBody.contactPhone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/get-calls'].post
  update:
    x-apievangelist-phrasing:
      intent: List a contact's calls
      effect: read
      questions:
      - What calls have we had with a particular contact?
      - Can I see a contact's call history for a date range?
      instructions:
      - text: List calls for contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Show contact {contactId}'s calls from {from} to {to}.
        slots:
          contactId: path.contactId
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/get-calls'].post
  update:
    x-apievangelist-phrasing:
      intent: List calls linked to a deal
      effect: read
      questions:
      - Which calls are attached to a deal?
      - Can I review the call log for one deal by call type?
      instructions:
      - text: List calls for deal {dealId}.
        slots:
          dealId: path.dealId
      - text: Show deal {dealId}'s calls of type {callType}.
        slots:
          dealId: path.dealId
          callType: requestBody.callType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deals/{dealId}/attach-call'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a call to a deal
      effect: write
      questions:
      - How do I link a phone call to a deal?
      - Can I attach a recorded call to the right deal afterwards?
      instructions:
      - text: Attach call {callId} to deal {dealId}.
        slots:
          callId: requestBody.callId
          dealId: path.dealId
      - text: Link call {callId} with deal {dealId}.
        slots:
          callId: requestBody.callId
          dealId: path.dealId
      method: generated
      generated: '2026-10-01'