> ## 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. # Get the caller's distinctive-ring rules > Returns the authenticated user's distinctive-ring rules plus the ring-pattern catalog for the picker. Each rule assigns a ring pattern (VIP, priority, urgent, …) to an exact caller number (`pstn`) or an E.164 prefix (`prefix`) so an important inbound call can be told apart by sound. Rules are saved to your account (not browser storage), so they survive clearing your browser or signing in from another device. ## OpenAPI ````yaml /openapi.yaml get /api/v1/me/ring-rules 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 - name: Risk description: >- Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping, URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one composite verdict queryable before a send or a call. - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/me/ring-rules: get: tags: - Account summary: Get the caller's distinctive-ring rules description: >- Returns the authenticated user's distinctive-ring rules plus the ring-pattern catalog for the picker. Each rule assigns a ring pattern (VIP, priority, urgent, …) to an exact caller number (`pstn`) or an E.164 prefix (`prefix`) so an important inbound call can be told apart by sound. Rules are saved to your account (not browser storage), so they survive clearing your browser or signing in from another device. responses: '200': description: Default Response content: application/json: schema: type: object required: - data - meta properties: data: type: object required: - rules - patterns properties: rules: type: array maxItems: 50 items: $ref: '#/components/schemas/DistinctiveRingRule' patterns: type: array items: $ref: '#/components/schemas/DistinctiveRingPattern' meta: type: object properties: request_id: type: string timestamp: type: string format: date-time '401': description: Default Response content: application/json: schema: type: object required: - error - meta properties: error: type: object required: - code - message properties: code: type: string message: type: string status: type: number details: {} meta: type: object properties: request_id: type: string timestamp: type: string format: date-time components: schemas: DistinctiveRingRule: type: object description: >- One per-caller distinctive-ring rule, saved per-user under `users.preferences.distinctive_ring_rules`. Assigns a ring pattern to an exact caller number (`pstn`) or an E.164 prefix (`prefix`). required: - match_kind - match_value - pattern properties: match_kind: type: string enum: - pstn - prefix match_value: type: string minLength: 1 maxLength: 32 description: >- An exact E.164 caller number when `match_kind` is `pstn` (e.g. `+14155551234`), or a leading-+ E.164 prefix when `match_kind` is `prefix` (e.g. `+1800`). pattern: type: string enum: - standard - priority - urgent - vip - internal - external label: type: string nullable: true maxLength: 64 DistinctiveRingPattern: type: object description: One entry in the distinctive-ring pattern catalog the picker renders. required: - id - label - alertInfo - priority properties: id: type: string enum: - standard - priority - urgent - vip - internal - external label: type: string alertInfo: type: string nullable: true description: >- The SIP `Alert-Info` header value carried on the inbound INVITE for this pattern, or null for `standard` (default ring, no header). priority: type: boolean 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_*) ````