Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Authy Reporting API

AuthyはREST APIを通じてレポーティングを行うことができます。 APIはHTTPレスポンスコードでステータスを示すよう設計れています。 レスポンスの本文(body)にはJSONまたはXML形式で追加情報が含まれています。 このAPIで照会できるすべてのイベントは「照会可能イベント」の見出し以下のサイドバー内で閲覧可能です。

現在はThe AuthyレポーティングAPIを使用すると、現在の日付から直近90日間のデータを照会できます。

APIエンドポイント

  • 現時点では下記のエンドポイントがあります: EventsおよびData Histogramです。

  • これらはパラメーターとしてX-Authy-API-Keyが必要な/protected/ API呼び出しです。

クエリー形式

クエリー形式は下記のパターンに従います。

    :param_name[:attribute][:operator]=:value

各APIエンドポイントにはいくつかのパラメーターがあります。 たとえば、Listイベントのパラメーター名「query」では、次のような属性、演算子、および値を指定できます。

    query[objects.phone_verification.s_country_code][eq]=371

サポートされる操作

Operator 概要
eq Equal
LT 未満
lte 小なりイコール
gt Greater Than
gte 大なりイコール
lk Like (〜と同様)

照会可能イベント

このAPIで照会できるすべてのイベントは「照会可能イベント」の見出し以下のサイドバー内で閲覧可能です。

Events

下記のエンドポイントはqueier serviceを使用してイベントを一覧します。

GET /protected/:format/reporting/events

パラメーター

名前 Type 概要
query 文字列 Query to list the events. See query format (📇 PII )
page integer Pages to display (maximum is 100) (🏢 not PII )
per_page integer The events to display per request (maximum 100) (🏢 not PII )

レスポンス

レスポンスは、下記の構造のJSONまたはXML文書になります。

events: list of events
   event: name of the event
   time: time of the event in iso8601 format 
   request_id: The ID of the request
   objects: Objects involved in the event. This is specific by event type.

利用制限

使用量は稼働を保証するためAuthy APIによって制限されます。 アプリケーションが使用制限に抵触した場合、エラーが返され、アプリケーションは一時的に停止されます。 時間 | 制限 | 文脈 :--- | :--- | :--- 分ごと | 30 | アプリケーションごと 時間ごと | 300 | アプリケーションごと

日付ヒストグラム

下記のエンドポイントはquerier serviceを使用して照会されたイベントの要約を返します。

GET /protected/:format/reporting/date_histogram

パラメーター

名前 Type 概要
page integer Page to display (maximum is 100) (🏢 not PII )
per_page integer The events to display per request (maximum 100). (🏢 not PII )
間隔 文字列 Allowed values are: "year", "quarter", "month", "week", "day", "hour", "minute". It also supports time settings like "1.5h" (up to "w" for weeks). (🏢 not PII )
scope[][] 文字列 Defines a scope for the query, for example if you want to filter by user you can pass: scope[user.authy_id][eq]=20 and the result would only have data related to that user id. The operator can be: lt, lte, gt, gte, eq (See query format) (📇 PII )
report[][][] 文字列 Defines the queries and conditions to run, for example it can be: queries[sent]event[eq]=token_sent The operator can be: lt, lte, gt, gte, eq (See query format) (📇 PII )

レスポンス

レスポンスは、下記の構造のJSONまたはXML文書になります。

interval: the given interval
reports:
    For every <name of report> given:
        timestamp: timestamp for the point in time
        time: time in iso8601 format
        count: how many times was the event found in the given interval

サンプル

SMSで電話番号検証を始める

$ curl -H "X-Authy-API-Key: 2WaB..." 'https://api.authy.com/protected/json/reporting/events?query[objects.phone_verification.s_via][gt]=sms'

{
  "events": [
    {
      "event": "phone_verification_failed",
      "time": "2016-08-19T12:00:58.205Z",
      "request_id": "75315f1b90534980715a7eb7c1a701bc",
      "objects": {
        "app": {
          "account_sid": "ACfaf520dc5dd2b79e59685eb072b50730",
          "id": 322,
          "name": "8-digit",
          "type": "trial"
        },
        "phone_verification": {
          "code_length": 4,
          "country_code": 1,
          "id": "6b98ecd0-4832-0134-6e68-0eb225da89af",
          "locale": "en",
          "phone_number": "a65739c2d6bc19dc98abded2d914d0fcb671a2001a3cce75d1bcc6dbba36927c",
          "seconds_to_expire": 559,
          "status": "pending",
          "via": "smsa"
        }
      }
    }
  ],
  "success": true
}

2016年10月3日からのログを取得する

$ curl -H "X-Authy-API-Key: 2Wa..." 'https://api.authy.com/protected/json/reporting/events?query[time][gte]=2016-10-03T00:00:00.000Z&query[time][lte]=2016-10-03T23:59:59.999Z'

{
  "events": [
    {
      "event": "phone_verification_failed",
      "time": "2016-10-03T12:51:36.892Z",
      "request_id": "fe9dd05c4de093330e58e24e6d34dabe",
      "objects": {
        "app": {
          "account_sid": "ACfaf520dc5dd2b79e59685eb072b50730",
          "id": 322,
          "name": "8-digit",
          "type": "trial"
        },
        "phone_verification": {
          "code_length": 4,
          "country_code": 371,
          "id": "0b5c34b0-6b96-0134-0f90-0617297a0a13",
          "locale": "en",
          "phone_number": "a9fe7da5dbec4797a264b894294a6ed202547adfd85732235108bc26fbd03e75",
          "seconds_to_expire": 599,
          "status": "pending",
          "via": "nana"
        }
      }
    },
    {
      "event": "phone_verification_code_is_invalid",
      "time": "2016-10-03T13:01:35.295Z",
      "request_id": "a39253fabaad45979d7b034bf80ba119",
      "objects": {
        "app": {
          "account_sid": "ACfaf520dc5dd2b79e59685eb072b50730",
          "id": 322,
          "name": "8-digit",
          "type": "trial"
        },
        "phone_verification": {
          "code_length": 4,
          "country_code": 371,
          "id": "0b5c34b0-6b96-0134-0f90-0617297a0a13",
          "locale": "en",
          "phone_number": "a9fe7da5dbec4797a264b894294a6ed202547adfd85732235108bc26fbd03e75",
          "seconds_to_expire": 1,
          "status": "pending",
          "via": "sms"
        }
      }
    }
  ],
  "success": true
}

電話番号検証に失敗する

phone_verification_failedイベントを渡すと、失敗した電話検証が返されます。

Request: $ curl -H "X-Authy-API-Key: 2WaBmrIZYE8284ErM2RS5qRii4Ki3a7A" 'https://api.authy.com:4567/protected/json/reporting/events?query[event][eq]=phone_verification_failed'

Response:
{
  "events": [
    {
      "event": "phone_verification_failed",
      "time": "2016-10-03T12:51:36.892Z",
      "request_id": "fe9dd05c4de093330e58e24e6d34dabe",
      "objects": {
        "app": {
          "account_sid": "ACfaf520dc5dd2b79e59685eb072b50730",
          "id": 322,
          "name": "8-digit",
          "type": "trial"
        },
        "phone_verification": {
          "code_length": 4,
          "country_code": 371,
          "id": "0b5c34b0-6b96-0134-0f90-0617297a0a13",
          "locale": "en",
          "phone_number": "a9fe7da5dbec4797a264b894294a6ed202547adfd85732235108bc26fbd03e75",
          "seconds_to_expire": 599,
          "status": "pending",
          "via": "nana"
        }
      }
    },
    {
      "event": "phone_verification_failed",
      "time": "2016-08-19T02:07:20.939Z",
      "request_id": "75b2a30b30429383a8c6e5f27983ee7c",
      "objects": {
        "app": {
          "account_sid": "ACfaf520dc5dd2b79e59685eb072b50730",
          "id": 322,
          "name": "8-digit",
          "type": "trial"
        },
        "phone_verification": {
          "code_length": 4,
          "country_code": 371,
          "id": "52d31870-47de-0134-6e67-0eb225da89af",
          "locale": "en",
          "phone_number": "a9fe7da5dbec4797a264b894294a6ed202547adfd85732235108bc26fbd03e75",
          "seconds_to_expire": 57,
          "status": "pending",
          "via": "nana"
        }
      }
    }
  ],
  "success": true
}

認証の詳細

3月、4月、5月の全トークンイベント(OneCode、TOTP)を返します。 2ページ目、ページごとに10の結果

リクエスト:

curl -g "https://api.authy.com/protected/json/reporting/events?\
query[time][gte]=2017-03-01T00:00:00.000Z\
&query[time][lt]=2017-06-01T00:00:00.000Z\
&page=2\
&per_page=10\
&query[event][gte]=token_\
&query[event][lte]=totp_z" \
-H "X-Authy-API-Key: $AUTHY_API_KEY"

レスポンス:

{
   "events":[
      {
         "event":"token_verified",
         "time":"2017-05-02T18:58:33.941Z",
         "request_id":"5c4163e4454f71cbe8a65e904634a1e3",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "token":{
               "s_id":"40785821",
               "s_type":"SmsToken"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"totp_token_sent_via_call",
         "time":"2017-05-02T18:57:52.519Z",
         "request_id":"5408ccfe2545cb926cc5b69ec7ac8be5",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"token_verified",
         "time":"2017-05-02T18:56:04.981Z",
         "request_id":"9f4da95bccb1622d2e1c776caf46d30b",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "token":{
               "s_id":"40785821",
               "s_type":"SmsToken"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"totp_token_sent",
         "time":"2017-05-02T18:55:52.127Z",
         "request_id":"b4e15f7670620ac6fbebff3d45740135",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"token_verified",
         "time":"2017-05-02T18:55:02.924Z",
         "request_id":"211230c4ba4a3694fbaa4502641cd3cc",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "device":{
               "s_device_app":"authy",
               "s_device_type":"iphone",
               "s_errors":"",
               "s_id":"35890289",
               "s_ip":"70.214.84.244",
               "s_name":"iPhone",
               "s_user_agent":"Authy 20.2 rv:69 (iPhone; iPhone OS 9.3.3; en_US)",
               "s_version":"20.2",
               "t_creation_date":"2017-03-07T17:20:48.524Z",
               "t_last_used_date":"2017-05-02T18:55:02.898Z",
               "t_sync_date":"2017-05-02T18:54:38.845Z"
            },
            "token":{
               "b_locked":true,
               "s_id":"35890264"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"token_verified",
         "time":"2017-05-02T18:54:24.254Z",
         "request_id":"e071f3bf5341648386f57c1c3402f95f",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "device":{
               "s_device_app":"authy",
               "s_device_type":"iphone",
               "s_errors":"",
               "s_id":"29269971",
               "s_ip":"216.177.99.226",
               "s_name":"iPhone 7 Personal",
               "s_user_agent":"Authy 20 rv:65 (iPhone; iPhone OS 10.0.1; en_US)",
               "s_version":"20.2",
               "t_creation_date":"2016-12-13T14:30:04.516Z",
               "t_last_used_date":"2017-05-02T18:54:24.232Z",
               "t_sync_date":"2017-05-02T18:53:42.529Z"
            },
            "token":{
               "b_locked":true,
               "s_id":"29269948"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"token_verified",
         "time":"2017-05-02T18:53:51.937Z",
         "request_id":"20be0245854b7b8b8d9a10f750673a11",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "device":{
               "s_device_app":"authy",
               "s_device_type":"iphone",
               "s_errors":"",
               "s_id":"29269971",
               "s_ip":"216.177.99.226",
               "s_name":"iPhone 7 Personal",
               "s_user_agent":"Authy 20 rv:65 (iPhone; iPhone OS 10.0.1; en_US)",
               "s_version":"20.2",
               "t_creation_date":"2016-12-13T14:30:04.516Z",
               "t_last_used_date":"2017-05-02T18:53:51.911Z",
               "t_sync_date":"2017-05-02T18:53:42.529Z"
            },
            "token":{
               "b_locked":true,
               "s_id":"29269948"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"totp_token_sent",
         "time":"2017-05-02T13:05:44.978Z",
         "request_id":"287c77741986ded9a26e2c87de333b31",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "user":{
               "as_authy_ids":[
                  "1357924"
               ],
               "b_banned":false,
               "s_authy_id":"1357924",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"token_verified",
         "time":"2017-05-02T13:04:23.478Z",
         "request_id":"18c4a23cd7c294233189598e0289dc75",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "device":{
               "s_device_app":"authy",
               "s_device_type":"iphone",
               "s_errors":"",
               "s_id":"29269971",
               "s_ip":"66.65.101.299",
               "s_name":"iPhone 7 Personal",
               "s_user_agent":"Authy 20 rv:65 (iPhone; iPhone OS 10.0.1; en_US)",
               "s_version":"20.2",
               "t_creation_date":"2016-12-13T14:30:04.516Z",
               "t_last_used_date":"2017-05-02T13:04:23.454Z",
               "t_sync_date":"2017-05-02T13:03:52.567Z"
            },
            "token":{
               "b_locked":true,
               "s_id":"29269948"
            },
            "user":{
               "as_authy_ids":[
                  "23456789",
                  "98765432"
               ],
               "b_banned":false,
               "s_authy_id":"23456789",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      },
      {
         "event":"token_verified",
         "time":"2017-04-13T21:17:19.755Z",
         "request_id":"8dc6bf4096694a0c6eaf89dfa571089b",
         "objects":{
            "app":{
               "s_account_sid":"AC2bor01eeb93cf1fc6544c2346denotto",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "user":{
               "as_authy_ids":[
                  "23456789",
                  "98765432"
               ],
               "b_banned":false,
               "s_authy_id":"23456789",
               "s_country_code":"1",
               "s_errors":"",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da11111"
            }
         }
      }
   ],
   "success":true
}

認証サマリー

3つのデータポイントの要約、(SMS/通話/プッシュ通知経由での)トークンの送信、検証に成功したトークン、無効なトークン、月ごとの要約、ページ1、1ページにつき50の結果、3月、4月、5月

リクエスト:

curl -g "https://api.authy.com/protected/json/reporting/date_histogram?\
&report[totp_token_sent][event][eq]=totp_token_sent\
&report[token_verified][event][eq]=token_verified\
&report[token_invalid][event][eq]=token_invalid\
&scope[time][gte]=2017-03-01T00:00:00.000Z\
&scope[time][lt]=2017-06-01T00:00:00.000Z\
&interval=month\
&page=1\
&per_page=50" \
-H "X-Authy-API-Key: $AUTHY_API_KEY"

レスポンス:

{
   "interval":"month",
   "reports":{
      "token_invalid":[
         {
            "timestamp":1491004800000,
            "time":"2017-04-01T00:00:00.000Z",
            "count":3
         },
         {
            "timestamp":1493596800000,
            "time":"2017-05-01T00:00:00.000Z",
            "count":3
         }
      ],
      "token_verified":[
         {
            "timestamp":1491004800000,
            "time":"2017-04-01T00:00:00.000Z",
            "count":3
         },
         {
            "timestamp":1493596800000,
            "time":"2017-05-01T00:00:00.000Z",
            "count":7
         }
      ],
      "totp_token_sent":[
         {
            "timestamp":1491004800000,
            "time":"2017-04-01T00:00:00.000Z",
            "count":0
         },
         {
            "timestamp":1493596800000,
            "time":"2017-05-01T00:00:00.000Z",
            "count":4
         }
      ]
   },
   "success":true
}

電話番号検証の詳細

4月における全電話番号検証イベントを返します。

リクエスト:

curl -g "https://api.authy.com/protected/json/reporting/events?\
query[time][gte]=2017-04-01T00:00:00.000Z\
&query[time][lt]=2017-05-01T00:00:00.000Z\
&query[event][gte]=phone_verification_\
&query[event][lt]=phone_verification_z" \
-H "X-Authy-API-Key: $AUTHY_API_KEY"

レスポンス:

{
   "events":[
      {
         "event":"phone_verification_started",
         "time":"2017-04-21T18:38:32.635Z",
         "request_id":"dcdf34ef998c28786c368ff71493722d",
         "objects":{
            "app":{
               "s_account_sid":"AC2b8781eeb93cf1fc6544c2346de9e6a5",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "phone_verification":{
               "i_seconds_to_expire":599,
               "line_type":"cellphone",
               "mccmnc":"310012",
               "s_code_length":"4",
               "s_country_code":"1",
               "s_errors":"",
               "s_id":"a515ba00-08ef-0135-b187-0a19a44cf006",
               "s_locale":"en",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da97602",
               "s_status":"pending",
               "s_via":"sms"
            }
         }
      },
      {
         "event":"phone_verification_code_is_valid",
         "time":"2017-04-21T18:32:30.601Z",
         "request_id":"2b27640665a172513e2fa4a56f1d3d35",
         "objects":{
            "app":{
               "s_account_sid":"AC2b8781eeb93cf1fc6544c2346de9e6a5",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "phone_verification":{
               "i_seconds_to_expire":398,
               "line_type":"cellphone",
               "mccmnc":"310012",
               "s_code_length":"4",
               "s_country_code":"1",
               "s_errors":"",
               "s_id":"55847910-08ee-0135-3004-0e5d6a065904",
               "s_locale":"es",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da97602",
               "s_status":"verified",
               "s_via":"call"
            }
         }
      },
      {
         "event":"phone_verification_started",
         "time":"2017-04-21T18:31:16.832Z",
         "request_id":"91193999a075d3fb72b4dd1b5ad9d671",
         "objects":{
            "app":{
               "s_account_sid":"AC2b8781eeb93cf1fc6544c2346de9e6a5",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "phone_verification":{
               "i_seconds_to_expire":472,
               "line_type":"cellphone",
               "mccmnc":"310012",
               "s_code_length":"4",
               "s_country_code":"1",
               "s_errors":"",
               "s_id":"55847910-08ee-0135-3004-0e5d6a065904",
               "s_locale":"es",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da97602",
               "s_status":"pending",
               "s_via":"call"
            }
         }
      },
      {
         "event":"phone_verification_started",
         "time":"2017-04-21T18:30:57.99Z",
         "request_id":"232cf89bb8a6246ecfb9bba0464e2868",
         "objects":{
            "app":{
               "s_account_sid":"AC2b8781eeb93cf1fc6544c2346de9e6a5",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "phone_verification":{
               "i_seconds_to_expire":491,
               "line_type":"cellphone",
               "mccmnc":"310012",
               "s_code_length":"4",
               "s_country_code":"1",
               "s_errors":"",
               "s_id":"55847910-08ee-0135-3004-0e5d6a065904",
               "s_locale":"es",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da97602",
               "s_status":"pending",
               "s_via":"call"
            }
         }
      },
      {
         "event":"phone_verification_started",
         "time":"2017-04-21T18:29:09.631Z",
         "request_id":"4e019ca385f095cc8a19688b710a258f",
         "objects":{
            "app":{
               "s_account_sid":"AC2b8781eeb93cf1fc6544c2346de9e6a5",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "phone_verification":{
               "i_seconds_to_expire":599,
               "line_type":"cellphone",
               "mccmnc":"310012",
               "s_code_length":"4",
               "s_country_code":"1",
               "s_errors":"",
               "s_id":"55847910-08ee-0135-3004-0e5d6a065904",
               "s_locale":"es",
               "s_phone_number":"f2527ef9a36461822fb9a793efbfcfbd9da97602",
               "s_status":"pending",
               "s_via":"call"
            }
         }
      },
      {
         "event":"phone_verification_started",
         "time":"2017-04-19T16:35:52.083Z",
         "request_id":"ded6c2394bf9c95edb8fd513eb55b7ba",
         "objects":{
            "app":{
               "s_account_sid":"AC2b8781eeb93cf1fc6544c2346de9e6a5",
               "s_device_app":null,
               "s_errors":"",
               "s_id":"15861",
               "s_name":"OwlBank",
               "s_type":"full"
            },
            "phone_verification":{
               "i_seconds_to_expire":599,
               "line_type":"cellphone",
               "mccmnc":"310150",
               "s_code_length":"4",
               "s_country_code":"1",
               "s_errors":"",
               "s_id":"2d0863d0-074c-0135-b933-0a77bbe8093e",
               "s_locale":"en",
               "s_phone_number":"a5f02bcfd3d852190576f440c1d9cadf50153f4a",
               "s_status":"pending",
               "s_via":"sms"
            }
         }
      }
   ],
   "success":true
}

電話番号検証の要約

3つのデータポイントの要約、電話検証開始、有効、無効、首対象が番号1、3月、4月、5月、週ごと、ページ1、1ページにつき50の結果

リクエスト:

curl -g "https://api.authy.com/protected/json/reporting/date_histogram?\
report[phone_verification_started][event][eq]=phone_verification_started\
&report[phone_verification_code_is_invalid][event][eq]=phone_verification_code_is_invalid\
&report[phone_verification_code_is_valid][event][eq]=phone_verification_code_is_valid\
&scope[objects.phone_verification.s_country_code][eq]=1\
&scope[time][gte]=2017-03-01T00:00:00.000Z\
&scope[time][lt]=2017-06-01T00:00:00.000Z\
&interval=week\
&page=1\
&per_page=50" \
-H "X-Authy-API-Key: $AUTHY_API_KEY"

レスポンス:

{
   "interval":"week",
   "reports":{
      "phone_verification_code_is_invalid":[
         {
            "timestamp":1492387200000,
            "time":"2017-04-17T00:00:00.000Z",
            "count":0
         }
      ],
      "phone_verification_code_is_valid":[
         {
            "timestamp":1492387200000,
            "time":"2017-04-17T00:00:00.000Z",
            "count":1
         }
      ],
      "phone_verification_started":[
         {
            "timestamp":1492387200000,
            "time":"2017-04-17T00:00:00.000Z",
            "count":5
         }
      ]
   },
   "success":true
}
Rate this page:

ヘルプが必要ですか?

誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。