Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dialogflow ES API (v2) Sip Trunks API

6 actions 6 updates phrasing extends openapi/google-dialogflow-sip-trunks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}'].get

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}'].delete

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}'].patch

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks'].get

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks'].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 Dialogflow ES API (v2) Sip Trunks API
  version: 1.0.0
extends: openapi/google-dialogflow-sip-trunks-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: 5
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SIP trunk
      effect: read
      questions:
      - What hostnames and connection status does one SIP trunk connected to Dialogflow report?
      - Can I check which certificate hostname a SIP trunk expects?
      instructions:
      - text: Get SIP trunk {trunk} in project {project}, region {location}.
        slots:
          trunk: path.sipTrunksId
          project: path.projectsId
          location: path.locationsId
      - text: Show the connections of SIP trunk {trunk} under {project}/{location}.
        slots:
          trunk: path.sipTrunksId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SIP trunk
      effect: destructive
      questions:
      - Can I disconnect and delete a SIP trunk from Dialogflow?
      - Will deleting a SIP trunk stop calls arriving from that carrier?
      instructions:
      - text: Delete SIP trunk {trunk} in project {project}, region {location}.
        slots:
          trunk: path.sipTrunksId
          project: path.projectsId
          location: path.locationsId
      - text: Remove telephony trunk {trunk} from {project}/{location}.
        slots:
          trunk: path.sipTrunksId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a SIP trunk
      effect: write
      questions:
      - How do I change the peer hostnames allowed on an existing SIP trunk?
      - Can I rename a SIP trunk or update its expected TLS hostname?
      instructions:
      - text: Set peer hostnames {hostnames} on SIP trunk {trunk}, project {project}, region {location}.
        slots:
          hostnames: requestBody.peerHostnames
          trunk: path.sipTrunksId
          project: path.projectsId
          location: path.locationsId
      - text: Rename SIP trunk {trunk} in {project}/{location} to {display_name}.
        slots:
          trunk: path.sipTrunksId
          project: path.projectsId
          location: path.locationsId
          display_name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks'].get
  update:
    x-apievangelist-phrasing:
      intent: List SIP trunks
      effect: read
      questions:
      - Which SIP trunks have I connected to Dialogflow telephony in a region?
      - Can I page through all SIP trunks in my project?
      instructions:
      - text: List SIP trunks in project {project}, region {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} SIP trunks at a time for {project}/{location}.
        slots:
          page_size: query.pageSize
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/sipTrunks'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a new SIP trunk
      effect: write
      questions:
      - How do I connect my carrier's SIP trunk to Dialogflow for phone calls?
      - What hostnames do I need to provide when creating a SIP trunk?
      instructions:
      - text: Create SIP trunk {display_name} with peer hostnames {hostnames} in project {project}, region {location}.
        slots:
          display_name: requestBody.displayName
          hostnames: requestBody.peerHostnames
          project: path.projectsId
          location: path.locationsId
      - text: Add a SIP trunk expecting TLS hostname {expected_hostname} in {project}/{location}.
        slots:
          expected_hostname: requestBody.expectedHostname
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'