Skip to main content
GET
Get Calling Settings
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


Query Parameters


Response

Success (200)


answered_by is api (your server answers with SDP, see Calling), 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.

Authorizations

Authorization
string
header
required

Your FlowIQ organisation API key (Settings → API Keys), sent as a bearer token. Format: Bearer fiq_YOUR_API_KEY

Query Parameters

include_sip_credentials
boolean

true to include the SIP password WhatsApp generated (needs the write scope)

Response

Success

organization_id
string<uuid>
calling
object

WhatsApp's calling settings for your number, as WhatsApp returns them

answered_by
enum<string>
Available options:
api,
stream,
flowiq
flowiq_ai_answers
boolean

FlowIQ's voice AI picks up incoming calls

stream
object | null

The media stream set for this number (header values hidden)