メッセージ

メッセージ API は (opens in a new tab)、エンゲージメントキャンペーンを実行するときに使用でき、最初のモバイル終端 (MT) メッセージを送信するときに新しい会話を作成します。

作成

チャネルと送信者が会話スレッド用に構成されている場合、受信メッセージは自動的にスレッド化されます。

送信メッセージを会話に追加するには、このメソッドを使用して、サポートされているチャネルのいずれかを介してメッセージを送信します (opens in a new tab) 。

x-agent-id属性がリクエスト HTTP ヘッダーに追加され、送信されるメッセージにエージェント識別子が提供されます。これは、統合が APIキーで認証し、エージェントエンティティを使用してメッセージを割り当てる場合に使用されます。

値はエージェントエンティティの主キーであるagentIdであり、「エージェント」エンドポイントへの応答で見つけることができます。

HTTP ヘッダーのすべての "Create Message" 要求に x-agent-id 属性を追加することは必須ではありません。このパラメーターの目的は、統合が APIキーで認証されるときにメッセージにエージェント識別子を提供することです。

動作は次のとおりです。

アカウントはエージェント と API を使用してメッセージを送信します - 割り当ての状態に基づいて、HTTP ヘッダーに x-agent-id 属性を含める必要がある場合があります。エージェントロールの検証が行われます。スーパーバイザーは、他のエージェントに割り当てられたメッセージを送信できます。
アカウントはエージェントを使用しません - 会話を未割り当てのままにし、リクエストヘッダーからx-agent-idを省略します。メッセージはどのエージェントにも帰属せず、通過します。

エージェントを使用しない場合は、会話は常に未割り当てのままにします。Create MessageリクエストHTTPヘッダーでは、x-agent-idパラメータを省略する必要があります。

ただし、エージェントを使用する場合は、メッセージを送信するためにアカウントに少なくとも1人のエージェントが必要です。エージェントの作成 API (opens in a new tab) を使用してエージェントを作成します (エージェントライセンスは必要ありません)。

ロールを使用してエージェントを作成し、メッセージのアクセス許可を管理する際には、次の点に注意してください。

Create MessageリクエストHTTPヘッダーには、x-agent-idパラメータと、対応する「agentId」をエージェント識別子として含める必要があります。

Get messages メソッドを使用して、会話で交換されるすべてのメッセージを取得します。