リンクトラッキングって？

オプションパラメーターの、track_link は、SMS APIで使用されます。

このオプションパラメーターが使われると、リンクトラッキング機能が作動します。
SMSのメッセージ本文中、最初に出てくる URLやドメイン名を自動で、独自の短縮URLに変換してリクエストを出します。 ※URLの前後は、最低1つの ASCII空白文字(0x20)を入れてください。
受信者が受信したメッセージ中のリンクをクリックすると、その日時が記録されます。
リンクトラッキングのコールバックURLを lt_callbackurl パラメータで指定している場合、指定されたURLをPOSTメソッドで呼び出します。
SMSの配信状態を確認するAPI を使って、クリックの記録情報を確認できます。

track_link を使って、SMSを送信する

オプションパラメータ track_link をリクエストに含めて、送信を行ってください。

{
    "sender": "(送信者)",
    "message": "test link tracking https://www.xoxzo.com/en/",
    "recipient": "(受信者の電話番号)",
    "track_link": "true"
}

リクエストが問題なく受け付けられると、メッセージID(msgid)が返されます。

{
    "msgid": "（メッセージID）"
}

SMSの受信を確認し、メッセージ中のURLをクリック

受信したデバイスを確認してください。メッセージ中にある、置き換えられたURLをクリックしてください。

lt_callbackurl で指定のURLを呼び出す

リンクトラッキング用ショートリンクがクリックされたとき、XOXZOクラウドシステムが lt_callbackurl で指定されたURLを呼び出します。
XOXZOクラウドシステムはこのURLをPOSTメソッドで呼び出します。
コールバックURLは http のステータス 200 で応答する必要があります。この応答をうけとるまで、最大１０回まで呼び出しを繰り返します。
このURLは、ショートリンクが最初にクリックされたとき１回のみ呼び出されます。

ステータスをAPIで確認

SMSの配信状態を確認するAPIを使います。
次の情報が返されます。
1. リンクがクリックされたか否か 2. クリックされていれば、その日時

{
    "status": "DELIVERED",
    "sender": "(送信者)",
    "url": "https://api.xoxzo.com/sms/messages/(msgid)/",
    "sent_time": "YYYY-MM-DD HH:MM:SS",
    "cost": (料金),
    "msgid": "(個別のメッセージID)",
    "tags": [],
    "recipient": "(受信者の電話番号)",
    "link_tracking": {
        "link": "https://www.xoxzo.com/en/",
        "shortlink": "https://(独自の短縮URL)",
        "accessed": true,
        "accessed_on": "YYYY-MM-DD HH:MM:SS"
    }

独自の短縮URLは、送信後90日にて無効となりますので、ご注意ください

詳しくは、ドキュメンテーションを参照してください。