GUgupshup
Voice Call Management

WhatsApp Voice call enable disable API

This API is used to enable/disable voice functionality at app level.

post/partner/app/{appId}/voice

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/voice
  • Auth
    HTTP bearer

Path parameters

appIdstring required

The unique identifier of the WhatsApp application

Request body application/x-www-form-urlencoded

enableboolean required

Flag to enable or disable voice call feature

iconVisibilitystring required

Controls the visibility of voice call icon

modestring required

Voice call mode configuration

metaDatastring required

Additional metadata for voice call configuration in JSON string format

Example request

{
  "enable": true,
  "iconVisibility": "DEFAULT",
  "mode": "GS_SIP",
  "metaData": "[{\"isregister\": false, \"user\": \"911141258312\", \"username\": \"911141258312\", \"host\": \"ip-10-232-3-155.ap-south-1.compute.internal\", \"port\": \"5071\", \"secret_key\": \"057d0443018fc94ac1488b86c0b7b0f2\", \"force_tcp\": false}]"
}

Response

Success

statusstring

Status of the voice call action

messagestring

Response message

Changes

No recorded changes to this operation across all 1 revision of this API.