Skip to content

Messaging CLI reference


Inspect, authorize, test, and revoke messaging links.

Use this page to inspect every public atoi channel command, its accepted flags, and one runnable example.

atoi channelInspect, authorize, test, and revoke messaging links.

CommandWhat it does
atoi channel listList messaging links and delivery state.
atoi channel viewRead one messaging link.
atoi channel getRead one messaging link with the get alias.
atoi channel authorizeOpen the browser-owned authorization flow for a messaging kind.
atoi channel testSend a receipt-backed test through one exact messaging link.
atoi channel revokeRevoke one exact messaging link.

#channel list

List messaging links and delivery state.

atoi channel list

FlagTypeDefaultValuesWhat it does
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run channel list

bash
atoi channel list --json

#channel view

Read one messaging link.

atoi channel view <link-id> [--link <link-id>]

FlagTypeDefaultValuesWhat it does
--linkstringSelect the exact link id instead of a positional id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run channel view

bash
atoi channel view lnk_8s3d --json

#channel get

Read one messaging link with the get alias.

atoi channel get <link-id> [--link <link-id>]

FlagTypeDefaultValuesWhat it does
--linkstringSelect the exact link id instead of a positional id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run channel get

bash
atoi channel get lnk_8s3d --json

#channel authorize

Open the browser-owned authorization flow for a messaging kind.

atoi channel authorize <telegram|slack|push>

FlagTypeDefaultValuesWhat it does
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run channel authorize

bash
atoi channel authorize slack --json

#channel test

Send a receipt-backed test through one exact messaging link.

atoi channel test --link <link-id> [--idempotency-key <key>]

FlagTypeDefaultValuesWhat it does
--link requiredstringSelect the exact link id.
--idempotency-keystringReuse a mutation identity when you safely retry the same action.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run channel test

bash
atoi channel test --link lnk_8s3d --idempotency-key test_release_1 --json

#channel revoke

Revoke one exact messaging link.

atoi channel revoke --link <link-id> --confirm [--idempotency-key <key>]

FlagTypeDefaultValuesWhat it does
--link requiredstringSelect the exact link id.
--confirm requiredbooleanConfirm the exact consequential action after you inspect its target.
--idempotency-keystringReuse a mutation identity when you safely retry the same action.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run channel revoke

bash
atoi channel revoke --link lnk_8s3d --confirm --json

Read Extend Atoi for the rest of this group, or the CLI reference index for every command.

Was this useful?