openapi.yaml

openapi: 3.1.0
info:
  title: SIP.TG REST API
  version: '1.0'
  description: |-
    REST API for SIP.TG partners

    # Error handling
    If an error occurs, the result may contain the following fields:
    | **Error field** | **Description**                                     |
    |-----------------|-----------------------------------------------------|
    | `error`         | Error code                                          |
    | `description`   | (optional) A more detailed description of the error |
    | `field`         | (optional) Parameter in which there is an error     |

    ## Common error codes
    | **Error code** | **Description**                                 |
    |----------------|-------------------------------------------------|
    | `unauthorized` | Authorization by token failed                   |
    | `not_found`    | Object not found                                |
    | `wrong_value`  | An invalid parameter value is specified         |
    | `max_accounts` | The limit of the number of objects is exceeded  |
    | `multiple_ids` | Prohibits a group change of the parameter value |
    | `db`           | Database error                                  |
    | `http_error`   | General HTTP error                              |
    | `tariff`       | Subscription limitations                        |
    | `no_user`      | Telegram user is not specified                  |
    | `unknown`      | Unknown error                                   |

    ## Errors in SIP account change and activation
    | **Error code**        | **Description**                                                                        |
    |-----------------------|----------------------------------------------------------------------------------------|
    | `params`              | Invalid connection parameters                                                          |
    | `timeout`             | SIP server waiting time exceeded                                                       |
    | `id`                  | SIP account not found                                                                  |
    | `busy`                | Another connection/disconnection operation is active                                   |
    | `session`             | Failed to activate the associated Telegram session                                     |
    | `worker`              | Worker is unavailable                                                                  |
    | `account`             | Wrong type of SIP account                                                              |
    | `restricted`          | Option change is prohibited                                                            |
    | `noauth`              | SIP server returned error 401                                                          |
    | `forbidden`           | SIP server returned error 403                                                          |
    | `noroute`             | SIP server returned error 404                                                          |
    | `no_registrar`        | (for account type `pbx-siptg`) No connection from the PBX                              |
    | `address_unavailable` | (for account type `ip-ip`) IP address does not respond to the test request             |
    | `reconnecting`        | (for account type `siptg-pbx` and `softphone`) SIP server is unavailable; reconnecting |
    | `no_username`         | (for account type `siptg-pbx` and `softphone`) SIP username is not specified           |
    | `no_password`         | (for account type `siptg-pbx` and `softphone`) SIP password is not specified           |
    | `no_domain`           | (for account type `siptg-pbx` and `softphone`) SIP domain and proxy are not specified  |
    | `no_address_port`     | (for account type `ip-ip`) Endpoint address and port are not specified                 |

    ## Errors in creating a Telegram session
    | **Error code**     | **Description**                                                            |
    |--------------------|----------------------------------------------------------------------------|
    | `unregistered`     | Phone number not registered in Telegram                                    |
    | `wrong_state`      | The session state does not allow authorization (see the `expected` field)  |
    | `wrong_operation`  | The session state does not allow this operation (see the `expected` field) |
    | `code_invalid`     | An invalid one-time code has been entered                                  |
    | `password_invalid` | An invalid 2FA password has been entered                                   |
    | `telegram_error`   | Telegram error (see `code` and `message` fields)                           |
    | `timeout`          | A time for session creating is out                                         |

    ## Errors in subscription activation
    | **Error code**       | **Description**                                          |
    |----------------------|----------------------------------------------------------|
    | `insufficient`       | Insufficient balance (see `cost` and `underpaid` fields) |
    | `already_paid`       | Invoice has already been paid                            |
    | `incorrect_currency` | Incorrect currency                                       |
    | `activate_denied`    | Activation of the subscription is not allowed            |
    | `no_changes`         | No changes                                               |
    | `paysystem_error`    | Payment system error                                     |
    | `not_processed`      | Not processed                                            |
    | `no_payment_method`  | No credit card (account) is linked                       |

    ## Errors with promo codes
    | **Error code** | **Description**                                                  |
    |----------------|------------------------------------------------------------------|
    | `invalid`      | Code is not valid                                                |
    | `tariff`       | Code is not valid for the subscription                           |
    | `personal`     | Code is valid only on the account of its owner                   |
    | `public`       | Code is not valid on the account of its owner                    |
    | `count_total`  | Code was used the maximum number of times                        |
    | `count_user`   | Code was used the maximum number of times on your account        |
    | `payments`     | Code can only be used for the first payment                      |
    | `refs`         | Code can be used only for the first connection with the referrer |
    | `date_begin`   | Code validity has not started yet                                |
    | `date_end`     | Code expired                                                     |
    | `currency`     | Code is not valid for the subscription currency                  |

    ## Errors with balance transfer
    | **Error code**       | **Description**                   |
    |----------------------|-----------------------------------|
    | `currency_missmatch` | Recipient has different balance   |
    | `forbidden_receive`  | Forbidden to receive the balance  |
    | `forbidden_send`     | Forbidden to send the balance     |
    | `insufficient`       | Insufficient funds on the balance |
  contact:
    name: SIP.TG support
    url: 'https://t.me/siptg_support'
    email: support@sip.tg
paths:
  /whoami:
    summary: ''
    get:
      tags: []
      summary: Info about user of token
      description: Returns the information about the user of token
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    description: Token owner's Telegram user ID
                    type: integer
                  balance:
                    type: string
                    description: User balance
                  credit:
                    type: string
                    description: Credit limit
                  credit_expire:
                    type: integer
                    description: Expiration timestamp of credit
                  debt:
                    type: string
                    description: Debt to prolong the credit expiration
                  currency:
                    type: string
                    description: Balance currency
                  lang:
                    type: string
                    description: Language
                  rewards:
                    type: object
                    description: Reward balances
                    properties:
                      '{currency}':
                        type: string
                        description: 'Rewards amount in `{currency}`'
                    required:
                      - '{currency}'
                required:
                  - user_id
                  - balance
                  - currency
                  - lang
              examples: {}
      operationId: get-whoami
    description: ''
  /storages:
    summary: ''
    get:
      tags: []
      summary: List of sessions storages
      description: Lists the sessions storages available to the user (private and shared)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  description: Storage
                  properties:
                    id:
                      type: string
                      description: Storage ID
                      pattern: ^\d+$
                    name:
                      type: string
                      description: Storage name
                    address:
                      type: string
                      description: 'Address:port of the storage'
                    owner_id:
                      type: integer
                      description: Telegram ID of the storage owner
                  required:
                    - id
                    - name
                    - address
                    - owner_id
      operationId: get-storages
    description: ''
  /sessions:
    summary: ''
    get:
      tags: []
      parameters:
        - in: query
          description: 'Search sample (username, user ID, or phone number)'
          required: false
          deprecated: false
          allowEmptyValue: false
          name: search
          schema:
            type: string
        - in: query
          description: Offset from which to display results
          deprecated: false
          schema:
            type: integer
          allowEmptyValue: false
          name: offset
      summary: List of Telegram sessions
      description: Lists available Telegram sessions (private and shared for administration)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - offset
                  - count
                  - count_tariff_shared
                  - count_tariff_allowed
                  - sessions
                properties:
                  offset:
                    type: integer
                    description: Real result offset
                  count:
                    type: integer
                    description: Total number of results
                  count_tariff_shared:
                    type: integer
                    x-stoplight:
                      id: wl5f0inncznpu
                    description: Amount of sessions sharing your tariff with
                  count_tariff_allowed:
                    type: integer
                    x-stoplight:
                      id: u63g7eqqscggd
                    description: Allowed amount of sessions to share your tariff with
                  sessions:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - user_id
                        - username
                        - phone
                        - storage_id
                        - active
                        - admin_tariff
                        - comment
                      properties:
                        id:
                          type: string
                          description: Session ID
                          pattern: ^\d+$
                        user_id:
                          type: integer
                          description: Telegram user ID
                        username:
                          type:
                            - string
                            - 'null'
                          description: Telegram username
                        phone:
                          type:
                            - string
                            - 'null'
                          description: Phone number of the account
                          pattern: ^\d+$
                        storage_id:
                          type: string
                          description: Sessions storage ID
                          pattern: ^\d+$
                        active:
                          type: boolean
                          description: Mark of active session
                        admin_tariff:
                          type: boolean
                          description: Share administrator's subscription with this session
                        comment:
                          type: string
                          x-stoplight:
                            id: y0mdk4vm8zqve
                          description: Comment for admin
      operationId: get-sessions
    description: ''
    post:
      description: Creates a new or prepares a terminated Telegram session ID for the authorization procedure. Prepared for login session is valud during 5 minutes.
      summary: Prepare Telegram session for login
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: ID of a terminated session
                storage_id:
                  type: integer
                  description: ID of a new sessions storage
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The assigned ID for the new session
                    pattern: ^\d+$
                  storage_id:
                    type: string
                    description: The ID of the assigned session storage
                    pattern: ^\d+$
                required:
                  - id
                  - storage_id
      operationId: post-sessions
  '/sessions/{id}/login':
    summary: ''
    post:
      tags: []
      summary: Login into Telegram session
      description: |-
        Controls the process of creating (authorizing) a new Telegram session.

        Possible **Errors in creating a Telegram session**.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - storage_id
                - operation
              properties:
                storage_id:
                  type: integer
                  description: Storage ID
                operation:
                  type: string
                  enum:
                    - phone_input
                    - code_login
                    - code_recovery_get
                    - code_recovery
                    - email_input
                    - code_email
                    - bot_token_input
                    - qr_code_get
                    - qr_code_wait
                    - password_input
                  description: |-
                    Operation of session creation phase:
                    - `phone_input` — start authorization with a phone number scheme;
                    - `code_login` — input a code from Telegram service account/SMS/Fragment...;
                    - `code_recovery_get` — request a recovery code by email;
                    - `code_recovery` — input a recovery code from email;
                    - `email_input` — an additional step to request email address to send a confirmation code to;
                    - `code_email` — input a confirmation code from email;
                    - `bot_token_input` — bot authorization;
                    - `qr_code_get` — authorization by using QR code;
                    - `qr_code_wait` — a pooling request for a new QR code or succesfull authorization (do not execute more than once every 5 seconds);
                    - `password_input` — input 2FA password.
                phone:
                  type: integer
                  description: (for operation `phone_input`) Phone number registered in Telegram
                bot_token:
                  type: string
                  description: (for operation `bot_token_input`) Bot authorization token
                code:
                  type: integer
                  description: '(for operations `code_login`, `code_recovery`, `code_email`) Confirmation code (from the service account or from email)'
                password:
                  type: string
                  x-stoplight:
                    id: 9ny7k15qo4l9q
                  format: password
                  description: (for operation `password_input`) 2FA password
                email:
                  type: string
                  description: (for operation `email_input`) Email address connected with Telegram account
                  format: email
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  next:
                    type:
                      - string
                      - array
                    enum:
                      - phone_input
                      - code_login
                      - code_recovery
                      - email_input
                      - code_email
                      - bot_token_input
                      - qr_code_get
                      - qr_code_wait
                      - password_input
                      - code_recovery_get
                    description: Expected next operation
                    nullable: true
                    items:
                      type: string
                  email:
                    type: string
                    description: 2FA email address pattern
                    format: email
                  qr_code:
                    type: string
                    description: URL for QR code generation
                  password:
                    type: string
                    description: New 2FA password
                    format: password
                  user_id:
                    type: integer
                    description: Telegram user ID of the created session
                required:
                  - next
      operationId: post-sessions-id-login
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        description: Session ID
        required: true
  '/sessions/{id}/configure':
    summary: ''
    post:
      tags: []
      summary: Configure Telegram account
      description: Configure Telegram account related to the session
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                settings:
                  x-stoplight:
                    id: lkqovhp6nfw44
                  description: |-
                    Setting to be applied to the account.
                    `calls_off_other_sessions` — disable receiving calls by other Telegram sessions;
                    `calls_allow_everybody` — allow receiving calls from all Telegram users, not only from contacts;
                    `calls_allow_p2p` — allow peer-to-peer calls;
                    `groups_disallow` — disallow inviting the account to groups.
                  type: array
                  items:
                    x-stoplight:
                      id: 0xiny95h3utzc
                    type: string
                    enum:
                      - calls_off_other_sessions
                      - calls_allow_everybody
                      - calls_allow_p2p
                      - groups_disallow
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  configured:
                    type: boolean
                    x-stoplight:
                      id: pp5k2bipupmr4
                    description: Result of configuring the account
                  error:
                    type: string
                    x-stoplight:
                      id: es6ew58wqt9zm
                    description: Error code
                  settings:
                    type: array
                    x-stoplight:
                      id: cxljsk4lxklsm
                    description: Lists options which was not applied in full
                    items:
                      x-stoplight:
                        id: vdf4cddi4bjih
                      enum:
                        - calls_off_other_sessions
                        - calls_allow_everybody
                        - calls_allow_p2p
                        - groups_disallow
      operationId: post-sessions-id-configure
      x-stoplight:
        id: c0teytpn1c2zn
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        description: Session ID
        required: true
  '/sessions/{id}':
    get:
      tags: []
      parameters: []
      description: Returns full details of the specified Telegram session
      operationId: get-sessions-id
      summary: Info about Telegram session
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - user_id
                  - username
                  - phone
                  - storage_id
                  - active
                  - dtmf_in
                  - dtmf_out
                  - redial
                  - lines
                  - msg_proc
                  - callback
                  - admin_tariff
                  - comment
                  - empty_bot_user_id
                  - empty_bot_query
                properties:
                  user_id:
                    type: integer
                    description: Telegram user ID
                  username:
                    description: Telegram username of the account
                    type:
                      - string
                      - 'null'
                  phone:
                    type:
                      - string
                      - 'null'
                    description: Phone number of the account
                    pattern: ^\d+$
                  storage_id:
                    type: string
                    description: Session storage ID
                    pattern: ^\d+$
                  active:
                    type: boolean
                    description: Mark of active session
                  dtmf_in:
                    type: boolean
                    description: Display DTMF for SIP→Telegram calls
                  dtmf_out:
                    type: boolean
                    description: Display DTMF for Telegram→SIP calls
                  redial:
                    type: boolean
                    description: Display Callback button
                  lines:
                    type: boolean
                    description: Display Lines button (callback through the line)
                  msg_proc:
                    type: boolean
                    description: 'Message processing (answering machine, call any number through PBX)'
                  callback:
                    type: boolean
                    description: Callback feature for calls
                  admin_tariff:
                    type: boolean
                    description: Share administrator's subscription with this session
                  comment:
                    type: string
                    x-stoplight:
                      id: 2t5241z80ztpv
                    description: Comment for admin
                  empty_bot_user_id:
                    type:
                      - integer
                      - 'null'
                    x-stoplight:
                      id: hc1vq4ayx1xsw
                    description: Inline bot user ID to use when no SIP accounts satisfies to call through
                  empty_bot_query:
                    type: string
                    x-stoplight:
                      id: l9p8ighid4mfk
                    description: Inline bot query format
    post:
      tags: []
      summary: Update Telegram session settings
      description: Makes changes to settings of the Telegram session
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                dtmf_in:
                  type: boolean
                  description: Display DTMF for SIP→Telegram calls
                dtmf_out:
                  type: boolean
                  description: Display DTMF for Telegram→SIP calls
                redial:
                  type: boolean
                  description: Display Callback button
                lines:
                  type: boolean
                  description: Displaying Lines button (callback through the line)
                msg_proc:
                  type: boolean
                  description: 'Message processing (answering machine, call any number through PBX)'
                callback:
                  type: boolean
                  description: Callback feature for calls
                admin_tariff:
                  type: boolean
                  description: Share administrator's subscription with this session
                empty_bot_user_id:
                  type: integer
                  x-stoplight:
                    id: qs7v0yan9z1f4
                  description: Inline bot user ID to use when no SIP accounts satisfies to call through; use `0` to reset
                empty_bot_query:
                  type: string
                  x-stoplight:
                    id: agqvvy5o9fv90
                  description: |-
                    Inline bot query format; supports variables:
                    `{text}` — text of the message from user;
                    `{userid}` — user ID.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  updated:
                    type: boolean
                    description: Updating result
                required:
                  - updated
      operationId: post-sessions-id
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: Session ID
    delete:
      summary: Terminate Telegram session
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleted:
                    type: boolean
                    description: Result of session termination and data deletion
                required:
                  - deleted
              examples: {}
      description: 'Ends, deletes or revokes control access to the Telegram session'
      operationId: delete-sessions-id
      parameters:
        - schema:
            type: string
            enum:
              - delete
              - logout
              - revoke
          in: query
          name: operation
          description: 'Type of delete session operation: `delete` — end session and delete related data; `logout` — end session with data saved; `revoke` — revoke session administration rights without ending session and deleting data'
          required: true
  '/sessions/{id}/resolve_user/{query}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: Telegram session ID
      - schema:
          type: string
        name: query
        in: path
        required: true
        description: Text of the query (phone number or username)
    get:
      summary: Resolve Telegram User ID
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: integer
                    description: Telegram User ID
                required:
                  - user_id
      operationId: get-sessions-id-resolve_user-query
      description: Gets the Telegram User ID by phone number or username through the specified session
  '/sessions/{id}/messages/{code}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: Session ID
      - schema:
          type: string
          enum:
            - ERROR_ORIGINATE_DIRECT
            - ERROR_ORIGINATE_DIRECT_CALLBACK_ON
            - ERROR_ORIGINATE_NO_PROVIDER
            - ORIGINATE_CHOOSE_LINE
            - ERROR_CALLER_ID_UNKNOWN
        name: code
        in: path
        required: true
        description: ID of the message
    get:
      summary: Get custom messages
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  '{lang}':
                    type:
                      - string
                      - 'null'
                      - array
                    description: 'Text of the message in HTML markup for the language with code `{code}`'
                    items:
                      type: string
      operationId: get-sessions-id-messages-code
      description: Get the customized messages for auto-reply feature
    post:
      summary: Set custom message
      operationId: post-sessions-id-messages-code
      responses:
        '200':
          description: OK
      description: Set the customized messages for auto-reply feature
      requestBody:
        content:
          application/json:
            schema:
              type:
                - object
                - string
              properties:
                '{lang}':
                  type:
                    - string
                    - 'null'
                    - array
                  description: 'New value of message in HTML markup for the language with code `{code}`; set `null` to return default value'
                  items:
                    type: string
  /sip_templates:
    get:
      summary: List of SIP templates
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  offset:
                    type: integer
                    description: Real results offset
                  count:
                    type: integer
                    description: Total number of results
                  sip_templates:
                    type: array
                    description: List of found SIP templates
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Template code
                        name:
                          type: string
                          description: Display name
                        free:
                          type: boolean
                          description: The mark of the free template (lift the restrictions for the free plan)
                        formats:
                          type: string
                          description: 'List of audio codecs in priority order (see [documentation](https://www.sip.tg/en/docs/codecs))'
                        dtmf:
                          type: string
                          description: 'List of DTMF command methods in priority order (see [documentation](https://www.sip.tg/en/docs/dtmf))'
                        transport:
                          type: string
                          description: The way to connect to the SIP Server
                          enum:
                            - udp
                            - tcp
                            - tls
                        out_rule:
                          type: string
                          description: 'Number conversion rules (see [documentation](https://www.sip.tg/en/docs/rewrite-rules))'
                      required:
                        - code
                        - name
                        - free
                        - formats
                        - dtmf
                        - transport
                        - out_rule
                required:
                  - offset
                  - count
                  - sip_templates
      operationId: get-sip_templates
      description: Lists SIP templates for Softphone mode
      parameters:
        - schema:
            type: string
          in: query
          name: search
          description: 'Search pattern (template code, part of the name)'
        - schema:
            type: integer
          in: query
          name: offset
          description: Offset from which to output the results
  /sip_accounts:
    get:
      summary: List of SIP accounts
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - offset
                  - count_active
                  - count_allowed
                properties:
                  count:
                    type: integer
                    description: Total number of results
                  offset:
                    type: integer
                    description: The actual offset of the results
                  count_active:
                    type: integer
                    x-stoplight:
                      id: 687vvyjog6ufo
                    description: Amount of active SIP accounts
                  count_allowed:
                    type: integer
                    x-stoplight:
                      id: ovh78jy2gfnjs
                    description: Amount of SIP accounts allowed to be active
                  sip_accounts:
                    type: array
                    description: List of found SIP accounts
                    items:
                      type: object
                      required:
                        - id
                        - name
                        - type
                        - state
                      properties:
                        id:
                          type: string
                          description: Account ID
                          pattern: ^\d+$
                        name:
                          type: string
                          description: Account name
                        type:
                          type: string
                          enum:
                            - softphone
                            - pbx-siptg
                            - siptg-pbx
                            - ip-ip
                          description: Account type
                        state:
                          type: string
                          enum:
                            - online
                            - offline
                            - error
                            - restricted
                            - unverified
                          description: |-
                            Account status:
                            `online` — connected;
                            `offline` — disconnected;
                            `error` — connection error;
                            `restricted` — restricted by subscription;
                            `unverified` — asigned softphone account must be verified (a succesfull outgoing call should be made through it)
      operationId: get-sip_accounts
      description: Lists the user's SIP accounts
      parameters:
        - schema:
            type: string
            enum:
              - gateway
              - softphone
          in: query
          name: mode
          description: 'SIP accounts of which mode to obtain: `gateway` — gateway mode; `softphone` — softphone mode'
          required: true
        - schema:
            type: integer
          in: query
          name: session_id
          description: (for Gateway mode) Session ID
        - schema:
            type: string
          in: query
          name: search
          description: 'Search sample (for Softphone mode; part of SIP template name, login, account name, registrar, Telegram user name; Telegram User ID or phone number)'
        - schema:
            type: integer
          in: query
          name: offset
          description: Offset from which to display results
    post:
      summary: Create SIP account
      operationId: post-sip_accounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: The ID of the created SIP account
              examples: {}
      description: Creates a new SIP account
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: Account type
                  enum:
                    - softphone
                    - pbx-siptg
                    - siptg-pbx
                    - ip-ip
                session_id:
                  type: integer
                  description: (for Gateway mode) Session ID in which the account should be created
              required:
                - type
    parameters: []
  /sip_accounts/encode:
    post:
      summary: Encode SIP credentials
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - hash
                  - url
                properties:
                  hash:
                    type: string
                    x-stoplight:
                      id: 25zd4bt90vn00
                    description: Hash ID
                  url:
                    type: string
                    x-stoplight:
                      id: fgnw5xbmhpdoi
                    description: Final URL containing hashed ID to share SIP credentials
      operationId: post-sip_accounts-encode
      x-stoplight:
        id: yu2paqyt1pell
      description: Encode SIP credentials of Softphone into the hashed ID for sharing with a URL link
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - username
                - password
              properties:
                username:
                  type: string
                  x-stoplight:
                    id: 9kmg99cigxryf
                  description: 'Username of SIP account; in case Authorization ID is different, use the form `username:authID`'
                password:
                  type: string
                  x-stoplight:
                    id: lleum2nnosbpq
                  description: Password of SIP account
                template_code:
                  type: string
                  x-stoplight:
                    id: wtmuv8vtyq4mp
                  description: 'Template code of SIP provider (to allocate one, contact [@siptg_support](https://t.me/siptg_support))'
                registrar:
                  type: string
                  x-stoplight:
                    id: 6oucxsn4ov37f
                  description: SIP server registrar (also known as SIP Proxy); can be omited if `template_code` is specified
                domain:
                  type: string
                  x-stoplight:
                    id: 3kshwjom90sjp
                  description: Domain name of SIP account
      security: []
  '/sip_accounts/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: SIP account ID
    get:
      summary: Info about SIP account
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - type
                  - formats
                  - dtmf
                  - out_rule
                  - last_used
                  - state
                  - restrictions
                  - worker
                properties:
                  name:
                    type: string
                    description: Account name
                  type:
                    type: string
                    enum:
                      - softphone
                      - pbx-siptg
                      - siptg-pbx
                      - ip-ip
                    description: Account type
                  formats:
                    type: string
                    description: 'List of audio codecs in order of priority (see [documentation](https://www.sip.tg/docs/codecs))'
                  dtmf:
                    type: string
                    description: 'List of DTMF command methods in order of priority (see [documentation](https://www.sip.tg/docs/dtmf))'
                  out_rule:
                    type: string
                    description: 'Number conversion rules (see [documentation](https://www.sip.tg/docs/rewrite-rules))'
                  last_used:
                    type: integer
                    description: Time when the account was used for a call last time
                  state:
                    type: string
                    description: |-
                      Account state:
                      `online` — connected;
                      `offline` — disconnected;
                      `error` — connection error;
                      `restricted` — restricted by subscription;
                      `unverified` — asigned softphone account must be verified (a succesfull outgoing call should be made through it)
                    enum:
                      - online
                      - offline
                      - error
                      - restricted
                      - unverified
                  restrictions:
                    type: array
                    description: |-
                      List of restrictions of use the SIP account in accordance with the subscription:
                      `worker` — paid Worker;
                      `other_users` — assigned a user for the account
                    uniqueItems: true
                    items:
                      type: string
                      enum:
                        - worker
                        - other_users
                  worker:
                    type: object
                    description: Information about used Worker server
                    required:
                      - id
                      - name
                      - active
                      - type
                    properties:
                      id:
                        type: string
                        description: Server ID
                        pattern: ^\d+$
                      name:
                        type: string
                        description: Server name
                      active:
                        type: boolean
                        description: Status of active server
                      type:
                        type: string
                        description: |-
                          Server type:
                          `official` — official SIP.TG server;
                          `public` — SIP.TG user's public server;
                          `private` — private server;
                          `template` — server for SIP template
                        enum:
                          - official
                          - public
                          - private
                          - template
                  user_id:
                    type: integer
                    description: (for Softphone mode) Telegram User ID
                  owner_id:
                    type: integer
                    description: (for Softphone mode) ID of the Telegram user who owns a SIP account
                  template:
                    type: object
                    description: (for Softphone mode) Information about the SIP template
                    required:
                      - code
                      - name
                    properties:
                      code:
                        type: string
                        description: Code of the template
                      name:
                        type: string
                        description: Template name
                  session_id:
                    type: string
                    description: (for Gateway mode) Telegram session ID
                    pattern: ^\d+$
                  caller_phone:
                    type: string
                    description: '(for Gateway mode) Caller ID values priority (one per line); possible values inside the rule: `{userid}`, `{username}`, `{phone}`'
                  caller_name:
                    type: string
                    description: '(for Gateway mode) Caller Name values priority (one per line); possible values inside the rule: `{userid}`, `{username}`, `{phone}`, `{name}`, `{name_ascii}`'
                  username:
                    type: string
                    description: '(for account types `softphone`, `pbx-siptg`, `siptg-pbx`) SIP account login'
                  password:
                    type: string
                    description: (for account type `pbx-siptg`) SIP account password
                  trusted_ips:
                    type: string
                    description: (for account type `pbx-siptg`) List of trusted IP addresses
                  registrar:
                    type: string
                    description: '(for account types `softphone`, `siptg-pbx`, `pbx-siptg`) Registration server address'
                  domain:
                    type: string
                    description: '(for account types `softphone`, `siptg-pbx`) Domain value'
                  transport:
                    type: string
                    description: '(for account types `softphone`, `siptg-pbx`) SIP server connection method: `udp`, `tcp` or `tls`'
                    enum:
                      - udp
                      - tcp
                      - tls
                  out_number:
                    type: string
                    description: '(for account types `siptg-pbx`, `ip-ip`) The number on PBX side to handle Telegram→SIP calls'
                  offline_since:
                    type: integer
                    description: '(for account types `softphone`, `siptg-pbx`) Time of detection of registration problem on external SIP server'
                  address:
                    type: string
                    description: (for account type `ip-ip`) IP address of SIP server on the other side
                  field_value:
                    type: string
                    description: '(for account type `ip-ip`) Additional attribute (field) in SIP messages in the format `{field}:{value}`'
                    pattern: '^\w+:\w+$'
                  recorder_active:
                    type: boolean
                    x-stoplight:
                      id: 77dp1ujtlplyr
                    description: (for Softphone mode) Default state of call recording for the account
                  recorder_chat_id:
                    type: integer
                    x-stoplight:
                      id: 6ypx9qxdrddeq
                    description: '(for Softphone mode) Chat ID to send recordings to, @siptg_bot should be a member of the chat'
                  priority:
                    type: integer
                    x-stoplight:
                      id: c69v0lhqkxepm
                    minimum: 0
                    maximum: 255
                    description: (for Gateway mode) Call priority for Telegram→SIP calls
      operationId: get-sip_account-id
      description: Returns full details of the specified SIP account
  '/sip_accounts/{id}/workers':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: SIP account ID
    get:
      summary: List of Workers for SIP account
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  offset:
                    type: integer
                    description: Real results offset
                  count:
                    type: integer
                    description: Total number of results
                  workers:
                    type: array
                    description: List of found Worker servers
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Server ID
                          pattern: ^\d+$
                        name:
                          type: string
                          description: Server name
                        address:
                          type: string
                          description: Server address
                        owner_id:
                          type: integer
                          description: Telegram User ID who owns the server
                          nullable: true
                        free:
                          type: boolean
                          description: Mark of free server
                        restricted:
                          type: boolean
                          description: Mark of restrictions the server by the subscription
                      required:
                        - id
                        - name
                        - address
                        - owner_id
                        - free
                        - restricted
                required:
                  - offset
                  - count
                  - workers
      operationId: get-sip_accounts-id-workers
      description: Returns the list of Worker servers available for use with the specified SIP account
      parameters:
        - schema:
            type: boolean
          in: query
          name: auto
          description: Return one of the most suitable Worker server
        - schema:
            type: string
          in: query
          name: search
          description: 'Search pattern (part of the name, address or owner''s username)'
        - schema:
            type: integer
          in: query
          name: offset
          description: Offset from which to display results
  '/sip_accounts/{ids}':
    parameters:
      - schema:
          uniqueItems: true
          type: array
          items:
            type: integer
        name: ids
        in: path
        required: true
        description: Comma-separated list of account IDs
        style: simple
    post:
      summary: Update SIP accounts settings
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Account ID
                      pattern: ^\d+$
                    updated:
                      type: boolean
                      description: Marks of updates in SIP account
                    password:
                      type: string
                      format: password
                      description: (for account type `pbx-siptg`) New password
                    worker_id:
                      type: string
                      description: The ID of the newly assigned Worker server
                      pattern: ^\d+$
                    error:
                      type: string
                      description: Error code (if any)
                    description:
                      type: string
                      description: Error description (if any)
                  required:
                    - id
      operationId: post-sip_accounts-ids
      description: |-
        Changes one or more (up to 10) SIP accounts.

        Possible **Errors in SIP account change and activation**.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Account name
                formats:
                  type: string
                  description: 'List of audio codecs in order of priority (see [documentation](https://www.sip.tg/docs/codecs))'
                dtmf:
                  type: string
                  description: 'List of used DTMF command methods in order of priority (see [documentation](https://www.sip.tg/docs/dtmf))'
                out_rule:
                  type: string
                  description: 'Number conversion rules (see [documentation](https://www.sip.tg/docs/rewrite-rules))'
                caller_phone:
                  type: string
                  description: '(for Gateway mode) Caller ID values priority (one per line); possible values inside the rule: `{userid}`, `{username}`, `{phone}`'
                caller_name:
                  type: string
                  description: '(for Gateway mode) Caller Name values priority (one per line); possible values inside the rule: `{userid}`, `{username}`, `{phone}`, `{name}`, `{name_ascii}`'
                user_id:
                  type: integer
                  description: (for Softphone mode) New User ID of the Softphone account
                template_code:
                  type: string
                  description: (for Softphone mode) SIP template code
                username:
                  type: string
                  description: '(for `softphone`, `siptg-pbx` account types) SIP account login; in case Authorization ID is different, use the form `username:authID`'
                password:
                  type: string
                  description: '(for account types `softphone`, `pbx-siptg`, `siptg-pbx`) SIP account password; for account type `pbx-siptg` asks to password generation on SIP.TG side'
                  format: password
                registrar:
                  type: string
                  description: '(for account types `softphone`, `siptg-pbx`) Registration server address'
                domain:
                  type: string
                  description: '(for account types `softphone`, `siptg-pbx`) Domain value'
                transport:
                  type: string
                  description: '(for account types `softphone`, `siptg-pbx`) Method of connection to SIP server'
                  enum:
                    - udp
                    - tcp
                    - tls
                trusted_ips:
                  type: string
                  description: (for account type `pbx-siptg`) List of trusted IP addresses
                field_value:
                  type: string
                  description: '(for account type `ip-ip`) Additional attribute (field) in SIP messages in format `{field}:{value}`'
                out_number:
                  type: string
                  description: '(for account types `siptg-pbx`, `ip-ip`) Number on PBX side to process Telegram→SIP calls'
                address:
                  description: (for account type `ip-ip`) IP address of SIP server on the other side
                  type: string
                worker_id:
                  type: integer
                  description: Worker server ID; use `0` for automatic selection
                password_check:
                  type: string
                  description: '(for account types `softphone`, `siptg-pbx`) Current SIP account password in case new Worker is not trusted (has type other than `official` or `template`)'
                  format: password
                recorder_active:
                  type: boolean
                  x-stoplight:
                    id: wwlg84308ke1s
                  description: (for Softphone mode) Record of all calls for the account by default
                recorder_chat_id:
                  type: integer
                  x-stoplight:
                    id: xpss3v3dpujsc
                  description: '(for Softphone mode) Chat ID to send recordings to, @siptg_bot should be a member of the chat'
                priority:
                  type: integer
                  x-stoplight:
                    id: x123a0tsw6qkn
                  minimum: 0
                  maximum: 255
                  description: (for Gateway mode) Call priority for Telegram→SIP calls
                reconnect:
                  type: boolean
                  description: Reconnect the account after making changes
                  default: true
    delete:
      summary: Delete SIP accounts
      operationId: delete-sip_accounts-ids
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Account ID
                      pattern: ^\d+$
                    deleted:
                      type: boolean
                      description: Result of account deletion
                    error:
                      type: string
                      description: Error code (if any)
                    description:
                      type: string
                      description: Error description (if any)
                  required:
                    - id
      description: Deletes one or more (up to 10) SIP accounts
  '/sip_accounts/{ids}/switch':
    parameters:
      - schema:
          uniqueItems: true
          type: array
          items:
            type: integer
        name: ids
        in: path
        required: true
        description: Comma-separated list of account IDs
        style: simple
    post:
      summary: Enable/disable SIP accounts
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: SIP account ID
                      pattern: ^\d+$
                    active:
                      description: New active status of the account
                      type: boolean
                    was_active:
                      type: boolean
                      description: (if disable) Previous state of the account
      operationId: post-sip_accounts-ids-switch
      description: |-
        Enables/disables one or more (up to 10) SIP accounts.

        Possible **Errors in SIP account change and activation**.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                active:
                  type: boolean
                  description: Enable/re-enable (`true`) or disable (`false`) the account
              required:
                - active
  '/sip_accounts/{id}/call':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: SIP account ID
    post:
      summary: Originate a call
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - callback
                properties:
                  callback:
                    type: boolean
                    x-stoplight:
                      id: 7x5l9i3yooyds
                    description: |-
                      Was or not a callback method used.
                      `false` requires outgoing call from the user to your gateway Telegram account in the next minute (you have to notify the user about it).
      operationId: post-sip_accounts-id-call
      x-stoplight:
        id: svf8rprcr8m92
      description: Originate a call with a specified Telegram user and a number on PBX side.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - user_id
                - number
              properties:
                user_id:
                  type: integer
                  x-stoplight:
                    id: 3y2gmisb2pecr
                  description: Telegram user ID to deliver the call to. You can use `0` in case of Softphone SIP account.
                number:
                  type: string
                  x-stoplight:
                    id: 2f7sl7nql1l0r
                  description: Phone number to call
  /tariffs:
    get:
      summary: List of subscriptions
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  offset:
                    description: Real results offset
                    type: integer
                  count:
                    description: Total number of results
                    type: integer
                  tariffs:
                    type: array
                    description: Information about subscriptions
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Subscription code
                        currency:
                          type: string
                          description: Currency
                        tags:
                          type: array
                          uniqueItems: true
                          description: Tags
                          items:
                            type: string
                            enum:
                              - softphone
                              - gateway
                              - group
                        name:
                          type: string
                          description: Subscription name
                        comment:
                          type: string
                          description: Comment for admin
                        period_type:
                          type: string
                          description: Periodicity of payment
                          enum:
                            - day
                            - week
                            - month
                            - year
                        admin_id:
                          type: integer
                          description: Telegram User ID of the subscription payer
                          nullable: true
                        user_id:
                          type: integer
                          description: Telegram User ID of the subscription customer
                        expire:
                          type: integer
                          description: Expire date
                          nullable: true
                        renew_auto:
                          type: boolean
                          description: Status of auto-renewal
                      required:
                        - code
                        - currency
                        - tags
                        - name
                        - comment
                        - period_type
                        - admin_id
                        - user_id
                        - expire
                        - renew_auto
                required:
                  - offset
                  - count
                  - tariffs
      operationId: get-tariffs
      description: 'Lists subscriptions available to the user (new, connected, and under administration)'
      parameters:
        - schema:
            type: string
          in: query
          name: lang
          description: Display language of subscriptions info
        - schema:
            type: string
          in: query
          name: search
          description: 'Sample search for administered subscriptions (by Telegram ID, phone number, username and comment part)'
        - schema:
            type: integer
          in: query
          name: offset
          description: Offset from which to display results
        - schema:
            type: boolean
            default: false
          in: query
          name: active
          description: '`true` — list active subscriptions, `false` — available for activation subscriptions'
  '/tariffs/{code}/{user_id}':
    parameters:
      - schema:
          type: string
        name: code
        in: path
        required: true
        description: Subscription code
      - schema:
          type: integer
        name: user_id
        in: path
        description: Telegram user ID (`0` for user of token)
        required: true
    get:
      summary: Info about subscription
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Subscription code
                  currency:
                    type: string
                    description: Currency
                  tags:
                    type: array
                    uniqueItems: true
                    description: Tags
                    items:
                      type: string
                      enum:
                        - softphone
                        - gateway
                        - group
                  name:
                    type: string
                    description: Subscription name
                  description:
                    type: string
                    description: Subscription description
                  comment:
                    type: string
                    description: Comment for admin
                    nullable: true
                  period_type:
                    type: string
                    enum:
                      - day
                      - week
                      - month
                      - year
                    description: Payment period
                    nullable: true
                  admin_id:
                    type: integer
                    description: Telegram User ID of the subscription payer
                    nullable: true
                  user_id:
                    type: integer
                    description: Telegram User ID of the subscription customer
                    nullable: true
                  expire:
                    type: integer
                    description: Expiration date
                    nullable: true
                  renew_auto:
                    type: boolean
                    description: State of subscription auto-renewal
                    nullable: true
                  period_constraints:
                    type:
                      - array
                      - 'null'
                    description: Possible values of the payment period
                    nullable: true
                    items:
                      type:
                        - string
                        - integer
                        - boolean
                  options:
                    type: object
                    description: Subscription options
                    properties:
                      '{code}':
                        type: object
                        description: 'Option `{code}` is used as a key'
                        properties:
                          type:
                            type: string
                            description: Option type
                            enum:
                              - string
                              - boolean
                              - seconds
                              - decimal
                              - integer
                              - unknown
                          flags:
                            type: array
                            description: |-
                              Option flags:
                              `variable` — option can be tuned up by user;
                              `cumulative` — option can't be decreased and aims to buy the new volume of services;
                              `activation_only` — option is applied only when subscription wasn't active;
                              `redefinable` — marks the option constraints (or value, pricing, etc.) should be redefined per-user basis;
                              `non_refundable` — prohibition of recalculation in case of subscription reduction.
                            items:
                              x-stoplight:
                                id: g5y0pbtmydowb
                              type: string
                              enum:
                                - variable
                                - cumulative
                                - activation_only
                                - redefinable
                          name:
                            type: string
                            description: Name of option
                          value:
                            description: Value of option
                            type:
                              - string
                              - integer
                              - boolean
                          used:
                            type: integer
                            description: In case the option is a quota — the current used value
                          constraints:
                            type:
                              - array
                              - 'null'
                            description: Possible values of the option
                            nullable: true
                            items:
                              type:
                                - string
                                - integer
                                - boolean
                          period:
                            type: object
                            description: Information about periodic option (which resets to zero `value` by the period of time)
                            properties:
                              type:
                                type: string
                                enum:
                                  - minutely
                                  - hourly
                                  - daily
                                  - weekly
                                  - monthly
                                  - yearly
                                description: Frequency for the option
                              value:
                                description: Period value
                                type: integer
                              expire:
                                description: Time when the `used` option value is reset
                                type: integer
                            required:
                              - type
                              - value
                              - expire
                        required:
                          - type
                          - flags
                          - name
                          - value
                          - constraints
                required:
                  - code
                  - currency
                  - tags
                  - name
                  - description
                  - comment
                  - period_type
                  - admin_id
                  - user_id
                  - expire
                  - renew_auto
                  - period_constraints
      operationId: get-tariffs-code-user_id
      description: Returns the full information about the specified subscription for the specified customer
      parameters:
        - schema:
            type: string
          in: query
          name: lang
          description: Language of subscription info display
    post:
      summary: Update subscription settings
      operationId: post-tariffs-code-user_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  updated:
                    description: Result of changes
                    type: boolean
                required:
                  - updated
      description: Makes changes in plan management
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                renew_auto:
                  type: boolean
                  description: Controls auto-renewal status
                comment:
                  type: string
                  description: Adds comment to the subscription
                admin_id:
                  type: integer
                  description: Changes (resets) the subscription payer
                  nullable: true
  '/tariffs/{code}/{user_id}/activate':
    parameters:
      - schema:
          type: string
        name: code
        in: path
        required: true
        description: Subscription code
      - schema:
          type: integer
        name: user_id
        in: path
        description: Customer User ID for which the subscription is about to activate (`0` for user of token)
        required: true
    post:
      summary: Activate (renew) subscription
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - active
                  - cost
                  - period
                  - expire
                  - options
                  - prices
                  - currency
                  - payment_id
                  - payment_url
                  - order_id
                properties:
                  active:
                    type: boolean
                    description: Mark the subscription is already activated
                  cost:
                    type: string
                    description: The cost of activating the subscription (in the currency of the user's token balance)
                  period:
                    type: integer
                    description: Period value of subscription extension (with applied restrictions)
                    nullable: true
                  expire:
                    type: integer
                    description: Current (after activation) expiration date
                    nullable: true
                  options:
                    description: Variable subscription options (with applied restrictions)
                    type: object
                    properties:
                      '{code}':
                        type:
                          - string
                          - integer
                          - boolean
                        description: 'Value of the option with `{code}` to change'
                  prices:
                    type: object
                    description: Explanation about what positions are included into the payment
                    required:
                      - base
                      - balance
                    properties:
                      base:
                        type: string
                        description: Base subscription cost
                      balance:
                        type: string
                        description: Balance changing
                      recalc:
                        type: string
                        description: Recalculation amount in case some options have changed for already activated subscription
                      period_discount:
                        type: string
                        description: Discount for the payment for a multiple period (multiple months; if applicable)
                      ref_discount:
                        type: string
                        description: Referral discount (if applicable)
                  currency:
                    type: string
                    description: The currency of `cost` and `prices`
                  payment_id:
                    type:
                      - string
                      - 'null'
                    description: Payment ID in case the subscription was activated
                  payment_url:
                    type: string
                    description: URL to pay via bot by user itself
                    format: uri
                  order_id:
                    type:
                      - integer
                      - 'null'
                    x-stoplight:
                      id: og6tfuyhycuo1
                    description: New Order ID in case the subscription was activated
      operationId: post-tariffs-code-user_id-activate
      description: |-
        Activates, extends and changes subscription options. The token owner becomes the subscription payer after activation.

        Possible **Errors in subscription activation** and **Errors with promo codes**.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                period:
                  type: integer
                  description: Period of subscription payment; do not specify if there are changes in subscription without its prolongation
                  nullable: true
                activate:
                  type: boolean
                  default: false
                  description: Confirmation of subscription activation
                'options.{code}':
                  description: 'Indicates the value of the option with code `{code}`'
                  type:
                    - string
                    - integer
                    - boolean
                promo_code:
                  type: string
                  description: Promo code
                option_tune:
                  type: string
                  description: Option code to make it tuned according to subscription duration restrictions
                order_id:
                  type: integer
                  x-stoplight:
                    id: wfjuy62va0aud
                  description: Order ID of previous subscription activation to inherit settings from
  '/balance/{user_id}/transfer':
    parameters:
      - schema:
          type: integer
        name: user_id
        in: path
        required: true
        description: User ID which the balance is transferred to
    post:
      summary: Balance transfer
      operationId: post-balance-user_id-transfer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  debit:
                    type: string
                    description: The amount to be debited
                  reward:
                    type: string
                    description: The discount amount as a reward
                  credit:
                    type: string
                    description: The amount to be credited (with applied constraints)
                  transferred:
                    type: boolean
      description: |-
        Transfer balance from the user of token to user with `user_id`.

        Possible **Errors with balance transfer**.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                amount:
                  type: string
                  description: The amount to be credited
                transfer:
                  type: boolean
                  description: Confirm balance transfer
              required:
                - amount
  '/receipts/{payment_id}':
    parameters:
      - schema:
          type: integer
        name: payment_id
        in: path
        required: true
        description: ID of payment transaction
    get:
      summary: Get receipt of the payment
      tags: []
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: object
      operationId: get-receipt-payment_id
      description: Get PDF receipt of the payment
components:
  securitySchemes:
    TokenAuth:
      type: http
      scheme: bearer
      description: |-
        You can get the token through @siptg_bot (section [/api](https://t.me/siptg_bot?start=api)).
        Available only to SIP.TG partner users.
      bearerFormat: ''
  schemas: {}
  headers: {}
  responses: {}
  parameters: {}
  examples: {}
externalDocs:
  url: 'https://www.sip.tg/docs'
tags: []
servers:
  - url: 'https://api.sip.tg'
    description: Production
    variables: {}
  - url: 'https://api.sip.tg/dev'
    description: Debug
security:
  - TokenAuth: []