Skip to main content
GET
/
v1
/
whatsapp
/
phone-numbers
/
{phoneNumberId}
/
settings
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/whatsapp/phone-numbers/{phoneNumberId}/settings \
  --header 'Authorization: Bearer <token>'
{
  "calling": {
    "status": "enabled",
    "callIconVisibility": "visible",
    "video": {
      "status": "enabled"
    },
    "ipAddresses": [
      "192.168.1.1"
    ],
    "callbackPermissionStatus": "granted",
    "sip": {
      "server": "sip.example.com",
      "username": "user123"
    }
  },
  "userIdentityChange": {
    "enableIdentityKeyCheck": true
  },
  "payloadEncryption": {
    "status": "disabled",
    "clientEncryptionKeyFingerprint": "<string>",
    "cloudEncryptionKey": "<string>"
  },
  "storageConfiguration": {
    "status": "default",
    "dataLocalizationRegion": "US"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.buildwithchirp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

​
phoneNumberId
string
required

WhatsApp phone number ID (internal Chirp ID)

Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Phone settings retrieved successfully

​
calling
object
required

Calling settings

​
userIdentityChange
object
required

User identity change settings

​
payloadEncryption
object
required

Payload encryption settings

​
storageConfiguration
object
required

Storage configuration settings