ドキュメント本文へスキップ
API

メッセージ内のサインインコードを読む

渡したメッセージ内の確認コード。コードリーダーが確信できるときに限る。

POST/tools/verification-code

実際の呼び出しをワークスペースに対して実行します。

POST /tools/verification-code

渡したメッセージ内の確認コード。コードリーダーが確信できるときに限る。

例

スコープは不要。MIME ソース全体を raw として送るか、subject と html または text を送る。code は入力するときと同じ形、つまり数字のみか大文字と数字の組み合わせで、空白やハイフンを含まずに返る。コードリーダーが確信できるコードがメッセージにない場合は null になる。

curl
curl -X POST "$OE/tools/verification-code" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "subject": "Your verification code", "html": "<p>Your code is <b>396-696</b>. It expires in 10 minutes.</p>" }'
レスポンス
{  "object": "verification_code",  "code": "396696"}

答えるのは、確認コード、ワンタイムコード、セキュリティコードなど、主要な言語のいずれかでコードと明記されたコードを、メッセージがちょうど 1 つ含むときだけである。異なる 2 つのコードや、注文、予約、会議、電話番号、プロモーションである可能性がある数字は code: null になる。

読むのは送られた内容だけなので、送信者が名乗るとおりの相手かどうかは判断できない。メールボックス内のメッセージの verificationCode は、それに加えて送信者が認証を通過していることも条件とする。何も保存されず、モデルも呼び出されない。

リファレンス