pbx-admin-forms

← All modules

2 endpoints.

POST /api/v1/pbx-admin-forms/proxy

Proxy

Forward one request to the box's real bespoke-form endpoint. path may be relative (/phone-numbers/item-options) OR the absolute URL the box's own item-options response hands back for its save/lookup routes (verified live — store_route/update_route/ get_routing_options are all absolute) — either way it must resolve under ALLOWED_PREFIXES. Raises the box's own error message on a 4xx/5xx — same "quote it verbatim" rule pbx_admin_api follows elsewhere.

Request body

{
  "properties": {
    "path": {
      "type": "string",
      "title": "Path"
    },
    "method": {
      "type": "string",
      "title": "Method",
      "default": "POST"
    },
    "data": {
      "additionalProperties": true,
      "type": "object",
      "title": "Data",
      "default": {}
    }
  },
  "type": "object",
  "required": [
    "path"
  ],
  "title": "ProxyBody"
}

200 — Successful Response

{}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

POST /api/v1/pbx-admin-forms/proxy-upload

Proxy Upload

Multipart twin of /proxy — the JSON proxy above can't carry a file. Only IVR Menus' Greet-Long "Upload" tab uses this today (/greetings/ upload-greeting, the same endpoint the box's own GreetingManager.tsx posts a FormData to).

200 — Successful Response

{}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}