Get sender status

Current connection status of one WhatsApp sender.

GET /whatsapp/senders/{id}/status

Get sender status

cURL

curl --request GET \
  --url https://api.pineyard.ai/whatsapp/senders/{id}/status \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "mode": "SHARED",
  "status": "CONNECTING",
  "numberSource": "PLATFORM_SHARED",
  "isDefault": true,
  "phoneDisplay": "<string>",
  "hasCredentials": true,
  "connectedAt": "<string>",
  "verifiedName": "<string>",
  "qualityRating": "<string>"
}

Required scope: whatsapp.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string<uuid> · required

Sender ID

Response

200

application/json

Sender status.

id · string · required

mode · enum<string> · required

Available options: SHARED, BYON, API

status · enum<string> · required

Available options: CONNECTING, CONNECTED, DISCONNECTED, REVOKED

numberSource · enum<string> · required

Available options: PLATFORM_SHARED, CLIENT_OWNED, PINEYARD_POOL

isDefault · boolean · required

phoneDisplay · string | null · required

hasCredentials · boolean · required

connectedAt · string | null · required

verifiedName · string | null · required

qualityRating · string | null · required