Channels

ChannelBinding object { business_id, channel, created_at, 2 more }

One linked channel identity: the Apple Messages for Business business this brand receives from and sends as.

business_id: string

The linked business id: a UUID issued at business registration.

channel: "amb"

The messaging channel. amb is the only channel this API serves today.

created_at: string

formatdate-time

entry_point_url: string

The Messages entry deep link for this binding (https://bcrw.apple.com/urn:biz:<business_id>); open it from an approved tester device to start a chat with the business and verify the link end to end. DERIVED from business_id, not stored: the URL format is platform knowledge, served here so no client composes it by hand.

origin: "seed" or "connect" or "control"

Where the link came from: connect is a self-service link (the Connect landing page, or POST /v1/channels: the same self-service path over this API), seed is boot configuration, control was provisioned by Linq. Provenance only; all three behave identically.

One of the following:

"seed"

"connect"

"control"

ChannelLinkResponse object { channel, outcome }

A decided link. outcome says whether this call created it.

channel: ChannelBinding { business_id, channel, created_at, 2 more }

One linked channel identity: the Apple Messages for Business business this brand receives from and sends as.

business_id: string

The linked business id: a UUID issued at business registration.

channel: "amb"

The messaging channel. amb is the only channel this API serves today.

created_at: string

formatdate-time

entry_point_url: string

The Messages entry deep link for this binding (https://bcrw.apple.com/urn:biz:<business_id>); open it from an approved tester device to start a chat with the business and verify the link end to end. DERIVED from business_id, not stored: the URL format is platform knowledge, served here so no client composes it by hand.

origin: "seed" or "connect" or "control"

Where the link came from: connect is a self-service link (the Connect landing page, or POST /v1/channels: the same self-service path over this API), seed is boot configuration, control was provisioned by Linq. Provenance only; all three behave identically.

One of the following:

"seed"

"connect"

"control"

outcome: "linked" or "already_linked"

linked (status 201); this call created the binding. already_linked (status 200): your brand already held exactly this binding; nothing changed and nothing is wrong. The two conflicts are errors, not outcomes: 409 brand_occupied (your brand already holds a DIFFERENT business id on the channel) and 409 cross_brand_conflict (the business id is held by another brand). A link is never re-pointed by this endpoint.

One of the following:

"linked"

"already_linked"

ChannelListResponse object { channels }

The brand’s linked channel identities.

channels: array of ChannelBinding { business_id, channel, created_at, 2 more }

Always an array; [] when nothing is linked yet, never null.

business_id: string

The linked business id: a UUID issued at business registration.

channel: "amb"

The messaging channel. amb is the only channel this API serves today.

created_at: string

formatdate-time

entry_point_url: string

The Messages entry deep link for this binding (https://bcrw.apple.com/urn:biz:<business_id>); open it from an approved tester device to start a chat with the business and verify the link end to end. DERIVED from business_id, not stored: the URL format is platform knowledge, served here so no client composes it by hand.

origin: "seed" or "connect" or "control"

Where the link came from: connect is a self-service link (the Connect landing page, or POST /v1/channels: the same self-service path over this API), seed is boot configuration, control was provisioned by Linq. Provenance only; all three behave identically.

One of the following:

"seed"

"connect"

"control"

Channels

List linked channels

Link a channel

ModelsExpand Collapse