status.md

description
This endpoint allows you to get connection status.

Connection Status

{% api-method method="get" host="https://api.wapim.co/api/v1/whatsapp" path="/status" %} {% api-method-summary %} Get Connection Status {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-headers %} {% api-method-parameter name="Authentication" type="string" required=true %} Authentication token. {% endapi-method-parameter %} {% endapi-method-headers %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} Status successfully retrieved. {% endapi-method-response-example-description %}

{
	"status": true,
	"code": 200,
	"message": {
		"Connected": true,
		"LoggedIn": true,
		"Idle": false,
		"phone_info": {
			"Battery": 49,
			"Platform": "iphone",
			"Connected": true,
			"Pushname": "John Doe",
			"Phone_number": "15417543010@c.us",
			"Lc": "US",
			"Phone": {
				"Mcc": "286",
				"Mnc": "002",
				"OsVersion": "12.4.4",
				"DeviceManufacturer": "Apple",
				"DeviceModel": "iPhone 5s",
				"OsBuildNumber": "undefined",
				"WaVersion": "2.20.21"
			},
			"Plugged": true,
			"Tos": 0,
			"Lg": "en",
			"Is_24_h": true
		}
	}
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

Example Usages

{% tabs %} {% tab title="Node.js" %}

const axios = require('axios');

axios
	.get('https://api.wapim.co/api/v1/whatsapp/status', {
		headers: {
			token: 'YOUR_WAPIM_TOKEN',
		},
	})
	.then(response => console.log(response.data))
	.catch(error => console.log(error.response.data));

{% endtab %}

{% tab title="cURL" %}

curl \
  -X GET https://api.wapim.co/api/v1/whatsapp/status \
  -H "token: YOUR_WAPIM_TOKEN"

{% endtab %} {% endtabs %}