Skip to content

配信数の上限・利用数・残数を取得​

GET
/usage

配信方法(メール・SMS・LINE)ごとの、配信数の上限・利用数・残数を返します。
メッセージを配信するときの上限の確認と同じルールで返します。

  • プランに配信方法が含まれない場合は、送信できません(available: false)。
  • 上限が設定されていない場合、メール・LINE は無制限(limit・remaining が null)、SMS は送信できません。
  • 上限は契約の枠と、追加購入などで付与された枠を合わせた数です。
    配信を開始したときに上限が足りなければ、そのメッセージは送信されずエラーになります。

Authorizations​

bearerAuth

テナントに発行された個人アクセストークン(Laravel Sanctum)を
Authorization: Bearer {token} ヘッダーで送信してください。

Type
HTTP (bearer)

Responses​

配信数の上限・利用数・残数

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"method": "string",
  
  
  
"available": true,
  
  
  
"limit": 0,
  
  
  
"used": 0,
  
  
  
"remaining": 0
  
  
}
  
],
  
"periodEndsOn": "string"
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI

MALINE テナント向けヘルプ