エージェントの作成

チャネルマネージャ API を使用してエージェントを作成するには、このエンドポイントを使用します。これは、ブランディングアセット（ロゴ、バナー）、ディスプレイ情報、電話番号、説明などの提供を含む、指定されたブランドのエージェントを登録します。

例

各コード・スニペットで使用されているすべての変数の説明を以下に示します：

キー	説明
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`VONAGE_APPLICATION_ID`	The Vonage Application ID.
`CHANNEL_MANAGER_RCS_AGENT_DISPLAY_NAME`	The unique display name of the RCS Agent.
`CHANNEL_MANAGER_RCS_AGENT_SENDER_ID`	A unique sender identifier for the RCS Agent on the Vonage platform.
`CHANNEL_MANAGER_RCS_AGENT_HOSTING_REGION`	The geographic location where your RCS business messaging service will be hosted and operated.
`CHANNEL_MANAGER_RCS_AGENT_PURPOSE`	Specifies the intended use of the RCS Agent.
`CHANNEL_MANAGER_RCS_AGENT_BILLING_CATEGORY`	Specifies the pricing model applied to messages sent via this RCS Agent.
`CHANNEL_MANAGER_RCS_BRAND_ID`	The ID of the RCS brand.
`CHANNEL_MANAGER_RCS_AGENT_TAGLINE`	A short phrase that represents the RCS Agent.
`CHANNEL_MANAGER_RCS_AGENT_BRAND_COLOR`	The hexadecimal color code for the primary color used in UI elements.
`CHANNEL_MANAGER_RCS_AGENT_PHONE_NUMBER`	End-user contact number in E.164 format.
`CHANNEL_MANAGER_RCS_AGENT_EMAIL_ADDRESS`	The contact email address for the RCS Agent.
`CHANNEL_MANAGER_RCS_AGENT_WEBSITE_ADDRESS`	The website address for the RCS Agent.

前提条件

申込書をお持ちでない場合は、ひとつ作る。ウェブフックの設定もご確認ください。

コードを書く

create-agent.sh に以下を追加する：

curl -X POST https://api.nexmo.com/v1/channel-manager/rcs/agents \
  -u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
  "basic_info": {
    "display_name": "'${CHANNEL_MANAGER_RCS_AGENT_DISPLAY_NAME}'",
    "sender_id": "'${CHANNEL_MANAGER_RCS_AGENT_SENDER_ID}'",
    "hosting_region": "'${CHANNEL_MANAGER_RCS_AGENT_HOSTING_REGION}'",
    "agent_purpose": "'${CHANNEL_MANAGER_RCS_AGENT_PURPOSE}'",
    "billing_category": "'${CHANNEL_MANAGER_RCS_AGENT_BILLING_CATEGORY}'",
    "brand_id": "'${CHANNEL_MANAGER_RCS_BRAND_ID}'"
  },
  "visual_design": {
    "tagline": "'${CHANNEL_MANAGER_RCS_AGENT_TAGLINE}'",
    "brand_color": "'${CHANNEL_MANAGER_RCS_AGENT_BRAND_COLOR}'",
    "phone": [
      {
        "number": "'${CHANNEL_MANAGER_RCS_AGENT_PHONE_NUMBER}'"
      }
    ],
    "email": [
      {
        "address": "'${CHANNEL_MANAGER_RCS_AGENT_EMAIL_ADDRESS}'"
      }
    ],
    "website": [
      {
        "url": "'${CHANNEL_MANAGER_RCS_AGENT_WEBSITE_ADDRESS}'"
      }
    ]
  },
  "application_settings": {
    "application_id": "'${VONAGE_APPLICATION_ID}'"
  }
}'

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

bash create-agent.sh