> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Preview a find-me/follow-me ring plan > Validates a posted ring ladder and returns the resolved plan — ordered dial legs with cumulative start/end offsets plus the terminal voicemail fallback. Stateless preview (persists nothing); used by the voice-preferences UI to render the ring schedule before save. ## OpenAPI ````yaml /openapi.yaml post /api/v1/voice/find-me-follow-me/plan openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway paths: /api/v1/voice/find-me-follow-me/plan: post: tags: - Voice summary: Preview a find-me/follow-me ring plan description: >- Validates a posted ring ladder and returns the resolved plan — ordered dial legs with cumulative start/end offsets plus the terminal voicemail fallback. Stateless preview (persists nothing); used by the voice-preferences UI to render the ring schedule before save. requestBody: required: true content: application/json: schema: type: object required: - steps additionalProperties: false properties: steps: type: array minItems: 1 maxItems: 5 description: >- Ordered ring ladder — the array index IS the ring order (index 0 rings first). items: type: object required: - kind - value additionalProperties: false properties: kind: type: string enum: - desk - mobile - softphone - pstn - sip value: type: string minLength: 1 maxLength: 512 description: >- Free-form device label for `desk`/`mobile`/`softphone`; an E.164 number for `pstn`; a `sip:` URI for `sip`. ring_seconds: type: integer minimum: 5 maximum: 120 default: 20 description: >- This step's ring window (seconds) before falling through to the next step. label: type: string maxLength: 64 fallback_to_voicemail: type: boolean default: true description: >- When true (default), the sequence ends at the user's voicemail box after the final step. When false, the leg falls to the route-level default (e.g. org auto-attendant). responses: '200': description: Default Response content: application/json: schema: type: object required: - data - meta properties: data: type: object required: - legs - total_ring_seconds - fallback properties: legs: type: array items: type: object required: - order - kind - value - start_offset_sec - ring_seconds - end_offset_sec properties: order: type: integer description: Zero-based ring order (0 rings first). kind: type: string enum: - desk - mobile - softphone - pstn - sip value: type: string label: type: - 'null' - string maxLength: 64 start_offset_sec: type: integer description: >- Whole-call offset (seconds) at which this leg STARTS ringing. ring_seconds: type: integer description: >- This leg's ring window (seconds) before falling through. end_offset_sec: type: integer description: >- Whole-call offset (seconds) at which this leg STOPS ringing. total_ring_seconds: type: integer description: >- Sum of every leg's ring window — the offset at which voicemail fires (when enabled). fallback: type: object required: - to_voicemail - at_offset_sec properties: to_voicemail: type: boolean at_offset_sec: type: integer meta: type: object properties: request_id: type: string timestamp: type: string format: date-time components: securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````