post
https://partner.gupshup.io/partner/bizgate/app//voice
Turns WhatsApp voice calling on or off for the app over SIP (mode=GS_SIP; the only mode offered to partners — omitting it defaults to GS_SIP, any other value is rejected with a 400, PP-8106).
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| appId | Identifier of the WhatsApp app the call acts on. | 6f414190-d45c-4671-bca1-fb6c3018cb13 | String | Required |
Body
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| enable | true enables voice calling for the app, false disables it. Required — the remaining fields tune how calling behaves. | true | — | Required |
| iconVisibility | Whether the call icon is shown in the chat. DEFAULT shows it, DISABLE_ALL hides it. Defaults to DEFAULT; omit the parameter to leave the current setting unchanged. | DISABLE_ALL | — | Optional |
| mode | How voice calling is routed. Only GS_SIP is available to partners — it routes calls over SIP and requires metaData. Omit the parameter to default to GS_SIP; any other value is rejected with a 400. | GS_SIP | — | Optional |
| metaData | SIP configuration, as a JSON ARRAY carried in this form field. Required when mode is GS_SIP and not needed otherwise. Each entry takes user, username, host, port, secret_key and force_tcp. | [{"user":"sip-user","username":"[email protected]","host":"sip.example.com","port":"5060","secret_key":" | — | Optional |
| additionalParams | Extra settings, as a JSON OBJECT carried in this form field. The one in use is call_hours: status is ENABLED or DISABLED, timezone_id is an IANA zone, weekly_operating_hours takes day_of_week with open_time and close_time as HHMM, and holiday_schedule takes date as YYYY-MM-DD with start_time and end_time as HHMM. Close time may not precede open time, holidays must be future dates, the timezone must be valid, at most two weekly entries are accepted, and schedules may not overlap. | {"call_hours":{"status":"ENABLED","timezone_id":"Asia/Kolkata","weekly_operating_hours":[{"day_of_week":"MONDAY","open_time":"0900","close_time":"1800"}],"holiday_schedule":[{"date":"2026-12-25","start_time":"0000","end_time":"2359"}]}} | — | Optional |
Sample cURL — Enable or disable voice calling.
curl --request POST \
--url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/voice' \
--header 'Authorization: Bearer <UT>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'enable=true' \
--data-urlencode 'iconVisibility=DISABLE_ALL' \
--data-urlencode 'mode=GS_SIP'Sample success response (200)
{
"status": "success",
"data": {
"message": "Whatsapp voice enabled successfully"
}
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…