Documentation Powered by ReDoc

SMS認証 APIドキュメント (1.0.0)

Download OpenAPI specification:Download

Authentication

BasicAuth

Basic authorization

Security Scheme Type HTTP
HTTP Authorization Scheme basic

sms v1 authentication

空電プッシュを利用したSMS認証API

authenticationsSend

sms認証コード送信API

Authorizations:
BasicAuth
header Parameters
Authorization
required
string
Example: Basic XXXXXX

{{api key}:{api secret}}をBase64 URLエンコードした値

Request Body schema: application/json
phone_number
required
string >= 11 characters [0-9]+$

SMS phone number

sms_message
required
string non-empty

@@@@@@を含めたメッセージ。最大140byte @@@@@@を認証コードに置き換えてSMS送信を行う

Responses

Request samples

Content type
application/json
{
  • "phone_number": "08012345678",
  • "sms_message": "@@@@@@があなたの認証コードです。"
}

Response samples

Content type
application/json
{
  • "sms_authentication_id": "70882f4c-b073-bead-dcaa-1a1bf035af2e"
}

authenticationsVerify

sms認証コード検証API。有効期限：5分、試行可能回数：5回

Authorizations:
BasicAuth
header Parameters
Authorization
required
string
Example: Basic XXXXXX

{{api key}:{api secret}}をBase64 URLエンコードした値

Request Body schema: application/json
sms_authentication_id
required
string 36 characters

SMS認証ID

auth_code
required
string 6 characters [0-9]+$

Responses

Request samples

Content type
application/json
{
  • "sms_authentication_id": "70882f4c-b073-bead-dcaa-1a1bf035af2e",
  • "auth_code": "934678"
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "code": 128,
  • "message": "Error detailed message"
}

sms v1

Send

sms送信API ショートメッセージを送信する

Authorizations:
BasicAuth
header Parameters
Authorization
required
string
Example: Basic XXXXXX

{{api key}:{api secret}}をBase64 URLエンコードした値

Request Body schema: application/json
phone_number
required
string >= 11 characters [0-9]+$

SMS phone number

sms_message
required
string [ 1 .. 70 ] characters

ショートメッセージ

Responses

Request samples

Content type
application/json
{
  • "phone_number": "08012345678",
  • "sms_message": "重要なお知らせがあります"
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "code": 128,
  • "message": "Error detailed message"
}