アウトバウンド統合

アウトバウンド統合:
Whatsapp > CRMとその他のシステム

この記事を開発者と共有するか、Zapierを使ってシステムをWhatsappと統合してください。

セットアップ

TimelinesAIは、ワークスペースに接続されたwhatsappアカウントで新しいメッセージが受信または送信されると、外部システムに通知することができます。これにはWhatsappモバイルアプリやTimelinesから送信されたメッセージも含まれます。

このような統合は、Zapierのような仲介サービスを介して利用されることが多く、Webhookの各アクティベーションがタスククォータの使用量にカウントされる。

タスククォータをより効率的に使用するために、TimelinesAI は選択された期間に特定のチャットで送受信された複数のメッセージを集約する可能性を提供します。メッセージは一つの "バンドル "としてウェブフック経由で送られます。便宜上、"bundle" にはあらかじめフォーマットされたメッセージの集計フィールド(と TimelinesAI の会話ポイントへのリンク)が含まれていますが、Webhook で提供されるデータを使って独自のフォーマットを実装することもできます。

スクリーンショット 2021 11 23 at 12 06 26
ウェブフック経由で送信されたメッセージのバンドル

Outbound Webhooksを使用して統合をセットアップするには:

  1. に移動する。 ウェブフックメニューに移動します。
  2. Outboundタブを選択します。

スクリーンショット 2021 11 23 at 11.47.21

以下の設定が表示されます:

  • 集計の粒度- ウェブフックを使って、選択(1/6/12/24時間ごと)またはタイムラインに表示され次第(「集計しない」)、メッセージが集計され送信されます。
  • Webhook URL- ここでは、通知する必要がある実際のURLを入力する必要があります。
  • Webhookが有効になっている- あなたは統合を停止したい場合は、Webhookを無効にすることができます。

Webhookが有効になり、いくつかのメッセージが送信されると、アクティビティログが表示されます(最新の10件まで)。

注意:現在、テキストと絵文字メッセージのみサポートされています。添付ファイルを含むメッセージはスキップされます。

エラーとトラブルシューティング

統合が正しく動作するように、受信側で連続 10 回以上のエラー (無効な URL から 200 以外の応答コードまで、あらゆるエラー) が発生した場合、システムは自動的に統合を無効にします。この場合、ワークスペースの所有者に電子メール通知が送信されます。

エラーのトラブルシューティングが必要な場合は、詳細なログをダウンロードすることができます(リンクはページの一番下にあります)。

データ形式

データは、HTTP POSTリクエストによって、JSON形式でWebhookのURLに送信されます。データは、集約粒度の設定に応じて、以下のように2つの異なる形式で提供されます。

X時間ごとに集計

メッセージは「バンドル」に集約される。以下のデータが利用可能になる:

  • 「whatsappアカウント" - メッセージが受信または送信されたwhatsappアカウント(およびそのアカウントに接続しているワークスペースのチームメイト)の詳細。
    • 「phone" - WAアカウントの電話番号
    • 「full_name" - Timelinesに登録されているWAアカウント所有者のフルネーム。
    • 「email" - Timelinesに登録されているWAアカウント所有者のEメール。
  • 「chat" - メッセージが送受信されたチャット(ダイレクトチャットまたはグループ)の詳細。
    • 「full_name" - チャット名(タイムラインに表示されるもの)
    • "responsible_name" - このチャットの責任者として割り当てられているチームメイトの名前。
    • "responsible_email" - このチャットの責任者として割り当てられているチームメイトのメール。
    • 「chat_url" - TimelinesUIでチャットにアクセスできるURL。
    • "chat_id" - TimelinesUIのチャットのID (チャットのURLを作成したり、インバウンドのウェブフックで使用できます)
    • 「is_new_chat" - このチャットが作成されたばかりの場合はtrue、そうでない場合はfalse。
    • 「is_group" - このチャットがダイレクトチャットの場合はtrue、そうでない場合はfalse
    • 「phone" - チャットの電話番号 (グループチャットの場合は空)
  • 「messages" - メッセージのリストで、各メッセージ・オブジェクトは以下のフィールドを含む。
    • "方向" - "受信 "または "送信 "が可能
    • 「timestamp" - UTCタイムゾーンでのメッセージのタイムスタンプ。
    • 「message_id" - メッセージの内部一意ID。
    • 「sender" - メッセージの送信者(チャットの参加者)の詳細。
      • "full_name" - チャットのタイトル、またはタイムライン上のチームメイトの名前(タイムライン内から送信された場合)。
      • 「phone" - 送信者の電話番号(グループチャットの場合は空白)
    • 「recipient" - メッセージの送信者(チャットの参加者)の詳細。
      • "full_name" - チャットのタイトル、またはタイムライン上のチームメイトの名前。
      • 「phone" - 受信者の電話番号 (グループチャットの場合は空)
    • 「text" - メッセージテキスト(プレーンテキスト)
  • "first_message_timestamp" - バンドル内の最も古いメッセージのタイムスタンプ。
  • "last_message_timestamp" - バンドル内の直近のメッセージのタイムスタンプ(UTCタイムゾーン)。
  • 「集約" - メッセージのテキストをHTML形式で集約したもので、CRMや同様のシステムでノートのコンテンツとして使用するのに適しており、タイムラインの最初のメッセージへの直接リンクを含む。

{
    "whatsapp_account" :
    {
        "full_name" : "Amnon Haha",
        "email" : "Amnon@acme.com",
        "phone" : "+972500000000"
    },
    "chat": 
    {
        "full_name": "John Doe>",
        "responsible_name": "Amnon",
        "responsible_email": "Amnon@acme.com",
        "chat_url" : "https://app.timelines.ai/chat/10010001/messages/",
        "chat_id" : "10010001",
        "is_new_chat" : true,
        "is_group": false, 
        "phone": "+97254000000"
    },
    "messages" :
    [
        {
            "direction": "sent", 
            "timestamp": "2021-02-24T16:25:29+0000",
            "message_id": "ddfskhsd76dsfs6dsd5skjsdhf",
            "sender": {
                "full_name": "John Doe",
                "phone": "+972540000000"
            },
            "recipient": {
                "full_name": "Jane Smith",
                "phone": "+972550000000"
            },
            "text": "lorem ipsum"
        },
        {
            "direction": "received", 
            "timestamp": "2021-02-24T16:30:29+0000",
            "message_id": "ddfskhsd76dsfs6dsd5skjsdhf",
            "sender": {
                "full_name": "John Doe",
                "phone": "+972540000000"
            },
            "recipient": {
                "full_name": "Jane Smith",
                "phone": "+972550000000"
            },
            "text": "lorem ipsum"
        }
    ],
    "first_message_timestamp" : "2021-02-24T16:25:29+0000",
    "last_message_timestamp" : "2021-02-24T16:30:29+0000",
    "aggregation":
        "from John Doe on 2021-02-24 16:25: Hi! How are you?<br/>from Jane Smith on 2021-02-24 16:30: I am fine, how are you?<br/>Click <a href='https://app.timelines.ai/permalink/77a28d55-5345-5435-8c72-3a7bcad8ded9/'>here</h> to open the conversation in TimelinesAI"
}

集計しない

各メッセージは、利用可能になり次第、個別に送信される。バンドル」は行われない。以下のデータが利用可能になります:

  • 「whatsappアカウント" - メッセージが受信または送信されたwhatsappアカウント(およびそのアカウントに接続しているワークスペースのチームメイト)の詳細。
    • 「phone" - WAアカウントの電話番号
    • 「full_name" - Timelinesに登録されているWAアカウント所有者のフルネーム。
    • 「email" - Timelinesに登録されているWAアカウント所有者のEメール。
  • 「chat" - メッセージが送受信されたチャット(ダイレクトチャットまたはグループ)の詳細。
    • 「full_name" - チャット名(タイムラインに表示されるもの)
    • "responsible_name" - このチャットの責任者として割り当てられているチームメイトの名前。
    • "responsible_email" - このチャットの責任者として割り当てられているチームメイトのメール。
    • 「chat_url" - TimelinesUIでチャットにアクセスできるURL。
    • "chat_id" - TimelinesUIのチャットのID (チャットのURLを作成したり、インバウンドのウェブフックで使用できます)
    • 「is_new_chat" - このチャットが作成されたばかりの場合はtrue、そうでない場合はfalse。
    • 「is_group" - このチャットがダイレクトチャットの場合はtrue、そうでない場合はfalse
    • 「phone" - チャットの電話番号 (グループチャットの場合は空)
  • 「message" - メッセージの詳細
    • "方向" - "受信 "または "送信 "が可能
    • 「timestamp" - UTCタイムゾーンでのメッセージのタイムスタンプ。
    • 「message_id" - メッセージの内部一意ID。
    • 「sender" - メッセージの送信者(チャットの参加者)の詳細。
      • "full_name" - チャットのタイトル、またはタイムライン上のチームメイトの名前(タイムライン内から送信された場合)。
      • 「phone" - 送信者の電話番号(グループチャットの場合は空白)
    • 「recipient" - メッセージの送信者(チャットの参加者)の詳細。
      • "full_name" - チャットのタイトル、またはタイムライン上のチームメイトの名前。
      • 「phone" - 受信者の電話番号 (グループチャットの場合は空)
    • 「text" - メッセージテキスト(プレーンテキスト)

{
    "whatsapp_account" :
    {
        "full_name" : "Amnon Haha",
        "email" : "Amnon@acme.com",
        "phone" : "+972500000000"
    },
    "chat": 
    {
        "full_name": "John Doe>",
        "responsible_name": "Amnon",
        "responsible_email": "Amnon@acme.com",
        "chat_url" : "https://app.timelines.ai/chat/10010001/messages/",
        "chat_id" : "10010001",
        "is_new_chat" : true,
        "is_group": false, 
        "phone": "+97251111111"
    },
    "message" :
       {
            "direction": "sent", 
            "timestamp": "2021-02-24T06:25:29+0000",
            "message_id": "ddfskhsd76dsfs6dsd5skjsdhf",
            "sender": {
                "full_name": "John Doe",
                "phone": "+972540000000"
            },
            "recipient": {
                "full_name": "Jane Smith",
                "phone": "+972550000000"
            },
            "text": "lorem ipsum"
        }
}
目次