Path
number
required
Agent ID from List agents.
Response
boolean
true if you can start a chat. If false, open the agent in the dashboard, save it, and try again.array
Every variable the agent uses. Send a value for each one in Start chat.
Agent chat
Prepare chat
List the variables to fill before chatting with an agent.
curl https://app.scalysis.com/api/v1/agent-scripts/2207/chat/prepare \
-H "Authorization: Bearer YOUR_API_KEY"
{
"success": true,
"script_id": 2207,
"script_name": "COD Confirmation",
"chat_ready": true,
"variables": [
{ "name": "agent_name", "required": true },
{ "name": "brand_name", "required": true },
{ "name": "customer_name", "required": true }
]
}
{ "success": false, "error": "Script not found" }
Step 1 of Chat with an agent. Tells you if the agent can chat and which variables to send. Free, no chat is started.
⌘I
curl https://app.scalysis.com/api/v1/agent-scripts/2207/chat/prepare \
-H "Authorization: Bearer YOUR_API_KEY"
{
"success": true,
"script_id": 2207,
"script_name": "COD Confirmation",
"chat_ready": true,
"variables": [
{ "name": "agent_name", "required": true },
{ "name": "brand_name", "required": true },
{ "name": "customer_name", "required": true }
]
}
{ "success": false, "error": "Script not found" }