受信

SMS受信一覧取得

受信したSMSの一覧を取得します。<br> パラメータを指定しない場合は最大100件を取得します。

get/api/v1/short_message_receptions

Request

  • Base URL: https://sandbox.cpaasnow.com
  • URL: https://sandbox.cpaasnow.com/api/v1/short_message_receptions
  • Auth: HTTP bearer

Query parameters

noticedboolean
Example:true

通知済みフラグ<br> WebhookのSMS受信による通知状況を指定できます。<br>

  • true: Webhookで通知済みのメッセージのみ取得<br>
  • false: Webhookで未通知のメッセージのみ取得<br>
  • 指定がない場合: 通知済み・未通知の両方を返します。
occurred_onstring
Example:2023-11-28

受信日<br> YYYY-MM-DD形式で指定してください。<br> 過去35日以内の日付が指定可能です<br> 指定がない場合は当日となります。

offsetinteger
Example:1

取得開始位置<br> 指定がない場合は0となります。

Response

OK

totalinteger required

受信SMSの取得件数

Example response

{
  "total": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.