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

# getUserWssCredentials

> ## Obtém dados de conexão do webphone

Retorna as credenciais websocket do usuário para conexão de webphone.

Retorna:

|  |  |
| --- | --- |
| url | Url completa da conexão websocket |
| host | Host da conexão websocket |
| ramal | Ramal do usuário |
| pass | Senha do websocket |
| port | \-- não usado -- |



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getUserWssCredentials
openapi: 3.0.0
info:
  title: IPBoX Api Documentation v1.1
  description: >-
    Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
    comandos são executados com chamadas POST e com respostas em formato JSON.
  version: 1.0.0
servers:
  - url: https://{baseUrl}
    description: Dominio (e porta, se houver) do servidor IPBoX do cliente
    variables:
      baseUrl:
        default: cliente.ipboxcloud.com.br:9052
        description: >-
          Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
          servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
          cliente.ipboxcloud.com.br:9052)
security:
  - ApiToken: []
tags:
  - name: Agente
  - name: Ligações
  - name: Prospects
  - name: Agendamentos
  - name: Listas
  - name: Filas
  - name: Lotes
  - name: Relatórios
  - name: Outros
  - name: Times
  - name: Blacklist
  - name: Áudios
  - name: URAs
paths:
  /ipbox/api/getUserWssCredentials:
    post:
      tags:
        - Agente
      summary: getUserWssCredentials
      description: |-
        ## Obtém dados de conexão do webphone

        Retorna as credenciais websocket do usuário para conexão de webphone.

        Retorna:

        |  |  |
        | --- | --- |
        | url | Url completa da conexão websocket |
        | host | Host da conexão websocket |
        | ramal | Ramal do usuário |
        | pass | Senha do websocket |
        | port | \-- não usado -- |
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                user:
                  type: string
                  description: Login do usuário
                  example: user
                senha:
                  type: string
                  description: Senha do usuário
                  example: senha
              required:
                - user
                - senha
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
        `Bearer ` / `Basic `.

````