serviceSettings

The serviceSettings API method allows users to view their WhatsApp account settings by providing their API key to the API endpoint. Users can access various account details and configurations, including:

Connection Status (connectionStatus): Indicates the current status of the service's connection.

WhatsApp Number (whatsAppNumber): The WhatsApp number associated with the service.

Country Code (countryCode): This code is used when sending messages to numbers without a country code prefix. By default, it is used as the country code prefix (Refer to countryCode section to set this option).

WhatsApp Receive Message Status (whatsAppReceiveMessage): If enabled, indicates that the service is capable of receiving messages, allowing users to process incoming messages.

Webhook (webhook): The configured webhook address. By default, it is empty. (Refer to Webhook section to set this option)

Account Level (level): Indicates the service level. Level 1 corresponds to a basic service, level 2 corresponds to a pro service, and level 3 corresponds to a premium service.

By utilizing the serviceSettings method, users can gain insights into their account's configuration and monitor various aspects of their WhatsApp service.

Responses

🟢200serviceSettings

application/json

Body

status

string

required

connectionStatus

string

required

whatsAppNumber

string

required

countrycode

string

required

statusCountryCode

string

required

whatsAppReceiveMessage

string

required

webhook

string

required

level

string

required

Example

{
    "status": "true",
    "connectionStatus": "Connected to WhatsApp",
    "whatsAppNumber": "15551234567",
    "countrycode": "1",
    "statusCountryCode": "When sending a message, if the phone number starts with zero, the  will replace zero",
    "whatsAppReceiveMessage": "Enable",
    "webhook": "",
    "level": "3"
}

Request

Request samples

Responses