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

# Get Calling Settings

> WhatsApp's calling settings for your number, and who answers incoming calls. Scope: read (write with include_sip_credentials).

WhatsApp's calling settings for your number (`calling`, as WhatsApp returns them) and who answers incoming calls (`answered_by`). Add `?include_sip_credentials=true` (needs the `write` scope) to see the SIP password WhatsApp generated.

## Basic Usage

```bash theme={null}
curl "https://api.flowiq.live/v1/calling/settings" \
  -H "Authorization: Bearer fiq_YOUR_API_KEY"
```

***

## Query Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `include_sip_credentials` | boolean | No | `true` to include `sip.servers[].sip_user_password` |

***

## Response

### Success (200)

```json theme={null}
{
  "organization_id": "a4234f32-…",
  "calling": {
    "status": "ENABLED",
    "call_icon_visibility": "DEFAULT",
    "callback_permission_status": "ENABLED",
    "call_hours": { "status": "DISABLED" },
    "sip": { "status": "DISABLED" }
  },
  "answered_by": "flowiq",
  "flowiq_ai_answers": false,
  "stream": null
}
```

***

`answered_by` is `api` (your server answers with SDP, see [Calling](https://docs.flowapt.com/flowiq-api-reference/calling.md#answer-incoming-calls-with-your-own-server)), `stream` (FlowIQ answers and streams the audio to `stream.url`) or `flowiq`. `flowiq_ai_answers` is `true` when FlowIQ's voice AI picks up incoming calls. `stream` shows the media stream target when one is set, with header values hidden.


## OpenAPI

````yaml flowiq-api-reference/openapi-calls.json GET /v1/calling/settings
openapi: 3.1.0
info:
  title: FlowIQ Calling API
  version: 1.0.0
  description: >-
    Run WhatsApp calls on your FlowIQ number from your own server: answer,
    decline, end and start calls, ask for call permission, read call history and
    change the number's calling settings. Every response carries X-Request-Id;
    errors carry a stable code; POST / PATCH accept Idempotency-Key.
servers:
  - url: https://api.flowiq.live
    description: FlowIQ Production API
security:
  - BearerAuth: []
paths:
  /v1/calling/settings:
    get:
      tags:
        - Calling
      summary: Get Calling Settings
      description: >-
        WhatsApp's calling settings for your number, and who answers incoming
        calls. Scope: read (write with include_sip_credentials).
      operationId: getCallingSettings
      parameters:
        - name: include_sip_credentials
          in: query
          required: false
          description: >-
            true to include the SIP password WhatsApp generated (needs the write
            scope)
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  organization_id:
                    type: string
                    format: uuid
                  calling:
                    $ref: '#/components/schemas/CallingSettings'
                  answered_by:
                    type: string
                    enum:
                      - api
                      - stream
                      - flowiq
                  flowiq_ai_answers:
                    type: boolean
                    description: FlowIQ's voice AI picks up incoming calls
                  stream:
                    type:
                      - object
                      - 'null'
                    description: >-
                      The media stream set for this number (header values
                      hidden)
                    properties:
                      url:
                        type: string
                      format:
                        type: string
                      headers:
                        type: object
                      custom_parameters:
                        type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CallingSettings:
      type: object
      description: WhatsApp's calling settings for your number, as WhatsApp returns them
      properties:
        status:
          type: string
          enum:
            - ENABLED
            - DISABLED
        call_icon_visibility:
          type: string
          enum:
            - DEFAULT
            - DISABLE_ALL
        call_icons:
          type: object
          properties:
            restrict_to_user_countries:
              type: array
              items:
                type: string
        callback_permission_status:
          type: string
          enum:
            - ENABLED
            - DISABLED
        call_hours:
          type: object
          properties:
            status:
              type: string
              enum:
                - ENABLED
                - DISABLED
            timezone_id:
              type: string
              example: Africa/Johannesburg
            weekly_operating_hours:
              type: array
              items:
                type: object
                properties:
                  day_of_week:
                    type: string
                    enum:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
                  open_time:
                    type: string
                    example: '0800'
                  close_time:
                    type: string
                    example: '1700'
            holiday_schedule:
              type: array
              items:
                type: object
        sip:
          type: object
          properties:
            status:
              type: string
              enum:
                - ENABLED
                - DISABLED
            servers:
              type: array
              items:
                type: object
                properties:
                  hostname:
                    type: string
                  port:
                    type: integer
                  request_uri_user_params:
                    type: object
                  sip_user_password:
                    type: string
                    description: Only with ?include_sip_credentials=true
        audio:
          type: object
          properties:
            additional_codecs:
              type: array
              items:
                type: string
                enum:
                  - PCMA
                  - PCMU
        voicemail:
          type: object
    Error:
      type: object
      properties:
        error:
          type: string
          description: Short label (Bad request, Not found, …)
        code:
          type: string
          description: Stable machine-readable code, see Conventions
        message:
          type: string
        request_id:
          type: string
          format: uuid
          description: Quote this to support
        whatsapp_error_code:
          type: integer
          description: WhatsApp's own code, on whatsapp_rejected
  responses:
    BadRequest:
      description: Invalid request, or WhatsApp refused it (the message says why)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Request failed
            message: Parameter value is not valid
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key lacks the scope, or the person has not given call permission
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Request failed
            message: Contact has not granted callback permission
    RateLimited:
      description: 240 reads or 60 actions per minute per key; Retry-After says when
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: fiq_ API key
      description: >-
        Your FlowIQ organisation API key (Settings → API Keys), sent as a bearer
        token. Format: `Bearer fiq_YOUR_API_KEY`

````

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