Skip to main content
GET
/
v1
/
organization
/
apps
/
{appId}
/
calling
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/apps/{appId}/calling \
  --header 'Authorization: Bearer <token>'
{
  "id": "cc_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "organizationId": "<string>",
  "voicemailEnabled": true,
  "voicemailGreetingUrl": "<string>",
  "voicemailMaxDuration": 123,
  "autoRecordEnabled": true,
  "recordingFormat": "mp4",
  "defaultAnswerBehavior": "webhook",
  "maxConcurrentCalls": 123,
  "whatsappCallingEnabled": true,
  "whatsappSipEnabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

appId
string
required
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Calling configuration retrieved successfully

id
string
required
Example:

"cc_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

appId
string
required
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

organizationId
string
required
voicemailEnabled
boolean
required
voicemailGreetingUrl
string | null
required
voicemailMaxDuration
integer
required
autoRecordEnabled
boolean
required
recordingFormat
enum<string>
required
Available options:
mp4,
ogg,
webm
defaultAnswerBehavior
enum<string>
required
Available options:
webhook,
voicemail
maxConcurrentCalls
integer
required
whatsappCallingEnabled
boolean
required
whatsappSipEnabled
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required