API reference

Simulate the customer

In the sandbox, reply as the customer or answer the call, so you can test every outcome without messaging anyone.

POST/v1/confirmations/{id}/simulate

With a test key, nothing reaches a real phone or inbox. This endpoint plays the customer's side instead: reply to the email or message in your own words, or answer the call and talk to the agent. The agent reads it exactly as it would a real reply, and the same outcomes and webhooks follow.

# Reply to the text as the customer would
curl -X POST https://api.anyonein.co.uk/v1/confirmations/cf_7d2a9c41e0b3f658/simulate \
  -H "Authorization: Bearer $ANYONEIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "reply", "channel": "sms", "text": "I am at work but my partner Jo will sign" }'

const simulate = (body) => fetch(`https://api.anyonein.co.uk/v1/confirmations/${id}/simulate`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.ANYONEIN_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify(body),
}).then((r) => r.json());

// Or answer the call when it rings, and talk to the agent
await simulate({ action: 'answer' });
const { confirmation } = await simulate({ action: 'say', text: "Tuesday's no good, any chance of Thursday?" });

def simulate(body):
    return requests.post(
        f"https://api.anyonein.co.uk/v1/confirmations/{cid}/simulate",
        headers={"Authorization": f"Bearer {os.environ['ANYONEIN_KEY']}"},
        json=body,
        timeout=30,
    ).json()

simulate({"action": "reply", "channel": "sms", "text": "Yes, I'll be in"})

<?php
$ch = curl_init("https://api.anyonein.co.uk/v1/confirmations/$id/simulate");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ANYONEIN_KEY'), 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['action' => 'reply', 'channel' => 'sms', 'text' => "Yes, I'll be in"]),
]);
$confirmation = json_decode(curl_exec($ch), true)['confirmation'];

Request body

actionstringrequired: reply, answer, say or decline.
channelstringoptional: For reply: sms (the default, the message step) or email.
textstringrequired for `reply` and `say`: What the customer writes or says, up to 1,000 characters.

`action`	What it does
`reply`	The customer replies to the email or message. The agent answers on the same channel and, if the answer is clear, closes the confirmation
`answer`	The customer answers the call, which must be ringing. The agent greets them
`say`	The customer says something on the call in progress. The agent's reply is added to the timeline
`decline`	The customer doesn't answer the ringing call, or hangs up the one in progress

Send the next step straight away with advance to get to the message or the call without waiting.

Returns

200 OK with the updated confirmation. The customer's words and the agent's answers are in and out events, with "live": false.

Errors

Status	`code`	When
`403`	`live_mode`	The key is a live key
`404`	`not_found`	No confirmation with that `id` for this key
`409`	`conflict`	No call is ringing (`answer`) or in progress (`say`, `decline`)
`422`	`validation_failed`	An unknown `action`, or `text` is missing
`429`	`rate_limited`	More than 120 in 10 minutes

Base URL https://api.anyonein.co.uk/v1 is a placeholder until the production domain is confirmed. Found a mistake? Tell us.

#Request body

#Returns

#Errors

Request body

Returns

Errors