WhatsApp · WhatsApp
Fetches ice breakers and commands.
GET
https://api.pozy.ai/v1/whatsapp/conversational-automationgetWhatsAppConversationalAutomation
Guides: Connect WhatsApp, Conversation starters
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Example
curl -X GET "https://api.pozy.ai/v1/whatsapp/conversational-automation?accountId=696e0b682d0a31188e7a2ba9" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/whatsapp/conversational-automation?accountId=696e0b682d0a31188e7a2ba9", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/whatsapp/conversational-automation",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
dataobjectenable_welcome_messagebooleanpromptsarray of stringUp to 3 items. Each item: 1 to 80 characters.
commandsarray of objectUp to 30 items.
2 child fields
command_namestringrequired1 to 30 characters. Matches
^[a-zA-Z0-9_]+$.command_descriptionstringrequired1 to 256 characters.
200 response
{
"data": {
"enable_welcome_message": true,
"prompts": [
"string"
],
"commands": [
{
"command_name": "Acme",
"command_description": "string"
}
]
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in WhatsApp
POSTRegister a connected WhatsApp number on the Cloud APIPOSTRequest a Meta re-verification code for a BYO WhatsApp numberPOSTVerify the Meta re-verification code for a BYO WhatsApp numberGETDownload WhatsApp mediaGETList templatesPOSTCreate templateGETGet templatePATCHUpdate templateDELDelete templateGETGet template by idPATCHUpdate template by idDELDelete template by idGETList the catalogs linked to a WhatsApp numberPOSTLink a catalog to a WhatsApp numberDELUnlink a catalog from a WhatsApp numberGETGet a number's commerce settingsPUTUpdate a number's commerce settingsPOSTSet ice breakers and commandsDELClear ice breakers and commandsGETGet business profilePOSTUpdate business profilePOSTUpload profile pictureGETGet display name statusPOSTRequest display name changeGETGet business usernamePOSTSet business usernameDELDelete business usernameGETGet username suggestionsGETCheck if a user is blockedGETList blocked usersPOSTBlock usersDELUnblock usersGETList account notificationsGETGet CTWA conversions datasetPOSTProvision CTWA datasetGETList active groupsPOSTCreate groupGETGet group infoPOSTUpdate group settingsDELDelete groupPOSTAdd participantsDELRemove participantsPOSTCreate invite linkGETList join requestsPOSTApprove join requestsDELReject join requestsGETList conversion eventsPOSTSend WhatsApp conversion event