Channels

Send a test message

POST/v1/channels/{id}/test

Queues a test message; follow its delivery on the notification in Location. 409 channel_inactive on a disabled channel.

Authentication: API key (Authorization: Bearer)
Required scope: write

Safe to retry with the Idempotency-Key header: see Idempotency.

Path parameters#

idstring · uuidrequired

Headers#

Idempotency-Keystring
Makes the POST safe to retry for 24 hours.

1 to 255 characters

Responses#

202Test message queued.

Response headers

Locationstring
/v1/notifications/{id}

Object fields

channel_idstring · uuid
notification_idstring · uuid
statusstring
Values queued

4xx · 5xxError.

Standard error format: see Errors.

Request

cURL

curl -X POST "https://aicscan.io/v1/channels/0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f/test" \
  -H "Authorization: Bearer $AICSCAN_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch('https://aicscan.io/v1/channels/0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os, uuid
import requests

resp = requests.post(
    "https://aicscan.io/v1/channels/0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f/test",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Response 202

JSON

{
  "channel_id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
  "notification_id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
  "status": "queued"
}