SimpleVoIP Time of Day API

openapi: 3.2.0
info:
  title: Simplevoip Time of Day API
  version: 1.6.0
  license:
    name: Proprietary
  description: 'Operations tagged Time of Day across 2 of this provider''s published API definitions: simplevoip.json, simplevoip-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://public.simplevoip.us
tags:
- name: Time of Day
  description: Bulk management of per-site call routing rules based on time of day.
paths:
  /accounts/{parent_id}/tod_rules:
    get:
      tags:
      - Time of Day
      operationId: fetchTodRules
      summary: Fetch TOD Rules
      description: Fetches all current Time of Day rule settings across all customer locations under the given parent account. Time of Day rules are used within Callflows to conditionally direct calls based on a site's local time of day, day of the week, or date — a site must have a callflow configured to use the specified rules for changes to have any effect on call routing. Contact your SimpleVoIP account manager to confirm your locations are Time of Day-enabled if you're unsure.
      security:
      - bearerAuth: []
      parameters:
      - name: parent_id
        in: path
        required: true
        schema:
          type: string
        description: Unique account ID of your parent account.
      - name: Accept
        in: header
        required: false
        schema:
          type: string
          enum:
          - application/json
          - text/csv
          default: application/json
        description: Both `text/csv` and `application/json` are accepted; any other value defaults to JSON.
      responses:
        '200':
          description: Rules keyed by site (or the same data as CSV, per `Accept`). Each JSON value's `_forced` fields are strings (`"on"`, `"off"`, or `""`), not booleans.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TodRulesResponse'
            text/csv:
              schema:
                type: string
        '400':
          description: Missing `parent_id`. No JSON body is returned — only the HTTP status.
        '403':
          description: The requesting bearer token's account does not match `parent_id` (and isn't an internal SimpleVoIP-staff-level token). No JSON body is returned — only the HTTP status.
    servers:
    - url: https://public.simplevoip.us
  /tod_rules:
    put:
      tags:
      - Time of Day
      operationId: modifyTodRules
      summary: Modify TOD Rules
      description: 'Enqueues a bulk job to modify Time of Day rules across one or more sites (the rules governing store open vs. closed logic).


        For more detailed info: https://support.simplevoip.com/hc/en-us/articles/7767228147607-Time-of-Day-Bulk-Change-API


        Only sites belonging to your own account are affected — any site number you don''t own is silently skipped (not reflected as an error; `enqueued_tasks` will simply be lower than the number of sites you sent). A `name` matching an existing rule updates it in place; a name that doesn''t yet exist for a site may create an incomplete rule, so this endpoint works most reliably against pre-existing rule names.'
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyTodRulesRequest'
            examples:
              default:
                value:
                  rules:
                  - name: MainTuesday
                    time_window_start: 32400
                    time_window_stop: 61200
                    enabled: false
                  - name: MainWednesday
                    time_window_start: 30000
                    time_window_stop: 63600
                  sites:
                  - A1001
                  - A1003
      responses:
        '200':
          description: Job enqueued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnqueueJobResponse'
              examples:
                success:
                  value:
                    status: success
                    enqueued_tasks: 2
        '401':
          description: Missing/invalid bearer token, or the token isn't associated with a recognized user. No JSON body is returned — only the HTTP status.
    servers:
    - url: https://public.simplevoip.us
components:
  schemas:
    EnqueueJobResponse:
      type: object
      required:
      - status
      - enqueued_tasks
      properties:
        status:
          type: string
          enum:
          - success
          - error
        enqueued_tasks:
          type: integer
          description: Number of per-site tasks enqueued.
    TodRulesResponse:
      type: object
      description: Keyed by site name.
      additionalProperties:
        $ref: '#/components/schemas/TodRuleSet'
    ModifyTodRulesRequest:
      type: object
      required:
      - rules
      - sites
      properties:
        rules:
          type: array
          items:
            type: object
            required:
            - name
            - time_window_start
            - time_window_stop
            properties:
              name:
                type: string
                description: Must match an existing rule name to update reliably.
              time_window_start:
                type: integer
                description: Seconds since midnight, site-local time.
              time_window_stop:
                type: integer
                description: Seconds since midnight, site-local time.
              enabled:
                type: boolean
        sites:
          type: array
          items:
            type: string
          description: Site numbers to apply the rules to. Site numbers you don't own are silently skipped.
    TodRuleSet:
      type: object
      description: One site's Time of Day rule set — one `_forced`/`_open`/`_close` trio per weekday.
      properties:
        sunday_forced:
          type: string
          description: '`"on"`, `"off"`, or `""` (not forced).'
        sunday_open:
          type: string
          description: Site-local time, `HH:MM`.
        sunday_close:
          type: string
          description: Site-local time, `HH:MM`.
        monday_forced:
          type: string
        monday_open:
          type: string
        monday_close:
          type: string
        tuesday_forced:
          type: string
        tuesday_open:
          type: string
        tuesday_close:
          type: string
        wednesday_forced:
          type: string
        wednesday_open:
          type: string
        wednesday_close:
          type: string
        thursday_forced:
          type: string
        thursday_open:
          type: string
        thursday_close:
          type: string
        friday_forced:
          type: string
        friday_open:
          type: string
        friday_close:
          type: string
        saturday_forced:
          type: string
        saturday_open:
          type: string
        saturday_close:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send an `Authorization: Bearer <token>` header. As a fallback for accounts without a bearer token configured, requests from an IP address on the account''s SimpleVoIP-managed allowlist are also accepted — bearer token is the recommended method for new integrations.'
x-refined-from:
- simplevoip.json
- simplevoip-openapi.json