> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brosbots.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zwolnij numer

> Zwraca numer do puli platformy.



## OpenAPI

````yaml /api-reference/openapi.pl.json post /api/v1/phone-numbers/release
openapi: 3.1.0
info:
  title: Brosbots API
  description: >
    Publiczne REST API Brosbots. Buduj i zarządzaj agentami głosowymi,

    uruchamiaj kampanie wychodzące, odczytuj rozmowy i zużycie oraz zarządzaj

    numerami telefonów, narzędziami, bazami wiedzy i integracjami.


    ## Uwierzytelnianie


    Każde żądanie musi zawierać klucz API organizacji w nagłówku `X-API-Key`:


    ```

    X-API-Key: bb_live_...

    ```


    Klucze tworzysz i unieważniasz w panelu: kliknij swoje konto w lewym dolnym
    rogu paska bocznego, a potem **Brosbots API**.


    ## Adres bazowy


    ```

    https://app.brosbots.com/api/v1

    ```


    ## Konwencje


    - Ciała żądań i odpowiedzi są w JSON (`Content-Type: application/json`).

    - Znaczniki czasu w ISO 8601 ze strefą czasową.

    - Listy stronicowane parametrami `page` / `limit`; odpowiedź zawiera
      `total_count` / `total_pages`.
    - Błędy używają standardowych kodów HTTP z ciałem JSON:
      `{"detail": "czytelny powód błędu"}`.
    - `{agent_id}` przyjmuje publiczne ID agenta (`agent_...`) albo jego numer.


    ## Limity


    API nie ma dziś stałego limitu liczby zapytań na klucz. Kod `429` zwracają

    endpointy dzwoniące (`POST /agents/{agent_id}/calls` i

    `POST /triggers/{trigger_id}/calls`), gdy wszystkie kanały wychodzące są
    zajęte; nagłówek `Retry-After` podaje, ile sekund odczekać.

    Obsługuj `429` ogólnie: czekaj tyle, ile mówi `Retry-After`, a gdy go nie ma
    -

    ponawiaj z wykładniczym odstępem. Limit zapytań może zostać wprowadzony.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
paths:
  /api/v1/phone-numbers/release:
    post:
      tags:
        - Numery telefonów
      summary: Zwolnij numer
      description: Zwraca numer do puli platformy.
      operationId: post_phone_numbers_release
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleasePhoneNumberRequest'
      responses:
        '200':
          description: Pomyślna odpowiedź
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberResponse'
        '404':
          description: Nie znaleziono
        '422':
          description: Błąd walidacji
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ReleasePhoneNumberRequest:
      properties:
        phone_number_id:
          type: integer
        accepted_fee_pln:
          anyOf:
            - type: number
            - type: 'null'
      type: object
      required:
        - phone_number_id
      title: ReleasePhoneNumberRequest
    PhoneNumberResponse:
      properties:
        id:
          type: integer
        phone_number:
          type: string
        provider:
          type: string
        country_code:
          anyOf:
            - type: string
            - type: 'null'
        capabilities:
          items:
            type: string
          type: array
          default: []
        friendly_name:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
        organization_id:
          anyOf:
            - type: integer
            - type: 'null'
        workflow_id:
          anyOf:
            - type: integer
            - type: 'null'
        workflow_name:
          anyOf:
            - type: string
            - type: 'null'
        outbound_workflows:
          items:
            $ref: '#/components/schemas/OutboundAgent'
          type: array
          default: []
        monthly_cost_usd:
          anyOf:
            - type: number
            - type: 'null'
        monthly_cost_pln:
          anyOf:
            - type: number
            - type: 'null'
        provider_number_id:
          anyOf:
            - type: string
            - type: 'null'
        purchased_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        assigned_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        order_id:
          anyOf:
            - type: integer
            - type: 'null'
        order_status:
          anyOf:
            - type: string
            - type: 'null'
        order_status_reason:
          anyOf:
            - type: string
            - type: 'null'
        outbound_commitment_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      type: object
      required:
        - id
        - phone_number
        - provider
        - status
      title: PhoneNumberResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
      title: HTTPValidationError
    OutboundAgent:
      properties:
        id:
          type: integer
        name:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - id
      title: OutboundAgent
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Klucz API organizacji (konto w lewym dolnym rogu panelu → Brosbots API).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.