Sign inGet Started

Get Apple Messages for Business channel settings

GET
/v1/amb/business-accounts/{business_account_id}/channel-settings
const result = await bird.amb.businessAccounts.settings.get(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(result);
प्रतिक्रिया200
{
  "entry_points": [
    {
      "id": "website-footer",
      "group": "support",
      "intent": "general-inquiry",
      "body": "Hi, I have a question about my order."
    }
  ],
  "default_locale": "en-US",
  "brand_name": "Acme Retail",
  "logo_asset_id": "ast_01krdgeqcxet5s7t44vh8rt9mg"
}

Returns the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page customers use to connect it.

पैरामीटर

business_account_idstring

ID of the Apple Messages for Business record, as returned by the business list.

Response Payload

entry_points
array of object
आवश्यक

The entry points customers can use to open a conversation with this business, each matched against the group and intent an inbound message reports.

चाइल्ड एट्रिब्यूट दिखाएँ
entry_points.id
string
आवश्यक

Identifier for this entry point, chosen by you and unique within the business's entry points. A conversation opened through this entry point carries it as entry_point.

entry_points.group
string
आवश्यक

The group value Apple reports on a conversation opened through this entry point. Matched against the group the first inbound message carries.

entry_points.intent
string
आवश्यक

The intent value Apple reports on a conversation opened through this entry point. Matched against the intent the first inbound message carries, together with group.

entry_points.body
string
आवश्यक

The message text pre-filled for the customer when they open a conversation through this entry point.

default_locale
nullable string

The locale used for this business when a conversation reports none of its own, in canonical BCP-47 form. Null until you set one or after you clear it. Bird converts a configured default to Apple's locale form when sending a message without a conversation locale.

brand_name
string
आवश्यक

The brand name shown on the Bird-hosted landing page customers use to connect this business.

logo_asset_id
nullable string
आवश्यक

The business's logo, as an asset in your media library. Null until one is set, either from Apple's own redirect or from a later change here.

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।