コンテンツにスキップ
Zelnum API

用語集

用語は、API が使う意味で定義します。日常的な、より緩い意味もある語については、API の意味が適用されます。

識別子とプロダクト

Section titled “識別子とプロダクト”
用語意味
識別子リアルタイムチェックが対象とする単一のもの。電話番号1つ、またはメールアドレス1つです。バルク送信は、それらのリストを運びます。
シリーズ識別子が phone か email のどちらであるか。プロダクト、エンドポイント、リクエストはすべてシリーズ固有であり、リクエストがシリーズを混ぜてよいのは、まったく混ぜてはならないという意味においてだけです。
プロダクト1つの検出対象 — プラットフォームと、それに対して行うチェックの種類。「WhatsApp Number Checker」と「WhatsApp Activity Details」は、どちらも WhatsApp に関するものですが、2つの異なるプロダクトです。
リアルタイムプロダクト同期エンドポイントを通じて使用するプロダクト。数値の ID で指定します。
バルクプロダクト非同期エンドポイントを通じて使用するプロダクト。スラッグ で指定します。
IDリアルタイムプロダクトを識別する整数で、カタログでは #47 として表示されます。product_ids が受け取るのは ID です。
スラッグバルクプロダクトを識別する文字列で、例えば waValid です。product フィールドが受け取るのはスラッグです。
モードrealtime または async。プロダクトはどちらか一方にのみ属し、モードが、どのエンドポイントがそれを受け付けるかを決めます。

判定

Section titled “判定”
用語意味
登録済み検出が実際に答えるのは、この識別子がこのプラットフォームに登録されているかどうかです。番号やアドレスが構文的に有効か、到達可能か、利用中かについて述べたものではありません。
valid登録済みと確認されました。課金されます。
invalid登録されていないと確認されました。課金されます — 否定的な回答も回答です。
unknownプロバイダーが解決できませんでした。課金されず、返金されます。
キャッシュ判定が、サプライヤーへの問い合わせではなく、保存されたファクトから提供されました。キャッシュヒットでも課金されます。
組み合わせ1つのリアルタイムリクエスト、1つの識別子、そしてそれをチェックした1〜10個のプロダクト。組み合わせは部分的に成功することがあります — partial_succeeded を参照してください。

金額

Section titled “金額”
用語意味
予約処理が実行される前に、金額を先に確保します。すべての送信は、アカウント残高に対して予約されます。
確定判定が判明した時点で、個々の項目の最終的な課金額を確定します。
返金使用可能な判定を生まなかった項目について、予約額を返します。
billing_status項目ごとのフィールド：charged または refunded。HTTP ステータスから推測するのではなく、これを読んでください。
total_reserved処理が実行される前に予約された額。常に total_charged + total_refunded と等しくなります。
charged_amount正味の課金額。refunded_amount は正味の返金額です。

リクエストとタスク

Section titled “リクエストとタスク”
用語意味
request_id1つのリアルタイム送信を識別する UUID。サポート依頼では、これを記載してください。
task_id1つのバルク送信を識別するトークンで、送信時に返されます。タスクエンドポイントの {token} パスパラメータでもあり、ドキュメント内では、1つの値に2つの名前があります。
Idempotency-Key呼び出し側が指定するヘッダーで、リアルタイム呼び出しでは必須です。再試行を安全にします。同じキーと同じボディであれば、再び課金する代わりに、保存済みの結果を返します。
リプレイレスポンスが、新たな処理ではなく、保存済みの結果から返されました。リアルタイムレスポンスでは replayed、バルク送信では idempotent_replay です。リプレイで金額が動くことはありません。
recovery_pendingバルクタスクはキューに入っていますが、その課金処理はまだ照合中です。

タスクカウンター

Section titled “タスクカウンター”
用語意味
submitted送信した行数。
prefiltered検出前に除外された行。例えば、形式が不正な行です。
deduped削除された重複行。
total実際にチェックされた行：submitted から prefiltered と deduped を引いたもの。
processed上流チャネルがこれまでに処理を完了した行数。
unknown_unprocessed解決されなかった行。これらが返金されます。

制限と保持

Section titled “制限と保持”
用語意味
キー単位の制限API キーに付随する予算。これをもとに計画してください。
IP 単位の制限1つのアドレスの背後にあるすべてのキーで共有される、より粗い上限。アクセス制御ではありません。
保持期間記録が残る期間。リアルタイムログとリプレイ結果は 30 日、バルク結果ファイルは 7 日です。

関連ページ

Section titled “関連ページ”