Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Verify Challenges API

3 actions 3 updates phrasing extends openapi/twilio-challenges-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/Services/{ServiceSid}/Entities/{Identity}/Challenges'].get

$.paths['/Services/{ServiceSid}/Entities/{Identity}/Challenges'].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 Twilio Verify Challenges API
  version: 1.0.0
extends: openapi/twilio-challenges-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: 2
- target: $.paths['/Services/{ServiceSid}/Entities/{Identity}/Challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: List push authentication challenges for a user
      effect: read
      questions:
      - Which login approval challenges has a user been sent recently?
      - Can I list only a user's pending or approved challenges for one factor?
      instructions:
      - text: List challenges for entity {identity} in Verify service {service_sid}.
        slots:
          identity: path.Identity
          service_sid: path.ServiceSid
      - text: List {status} challenges for user {identity} in service {service_sid}.
        slots:
          status: query.Status
          identity: path.Identity
          service_sid: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/Entities/{Identity}/Challenges'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a push authentication challenge
      effect: write
      questions:
      - How do I ask a user to approve a login from their phone with a push notification?
      - Can I show a custom message and extra context fields in the push challenge?
      instructions:
      - text: Send a push challenge to user {identity} on factor {factor_sid} in service {service_sid}.
        slots:
          identity: path.Identity
          factor_sid: requestBody.FactorSid
          service_sid: path.ServiceSid
      - text: Challenge {identity} via factor {factor_sid} in service {service_sid} with the message {message}.
        slots:
          identity: path.Identity
          factor_sid: requestBody.FactorSid
          service_sid: path.ServiceSid
          message: requestBody.Details.Message
      method: generated
      generated: '2026-09-26'