通知APIドキュメント
これらのエンドポイントを使用すると、 内部モバイル通知を送信する そして 通知履歴を取得する SMSMobileAPIから取得できます。通知は特定のモバイルデバイスに送信され、リストエンドポイントを通じて追跡できます。
の 通知/リスト エンドポイントは通知の送信時間と配信時間を返します GMT完全な日時文字列と Unixタイムスタンプ.
ヘルプが必要ですか? api@smsmobileapi.com
クイックスタート
ベースURL
得る https://api.smsmobileapi.com
以下の例はすべて次のように表示されます。 得る シンプルさを求める声。 通知/送信 エンドポイントも受け入れます 役職 そして JSONボディ。 交換する あなたのAPIキー 実際のキーを使用します。
例
GET https://api.smsmobileapi.com/notification/send?apikey=YOUR_API_KEY&sid=TARGET_SIDENTIFIANT&title=Notification&message=Helloworld&type=notification
GET https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY
GET https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY&sidentifiant=TARGET_SIDENTIFIANT&distribued=1&date_from=2026-03-01&date_to=2026-03-18
認証
通知エンドポイントは、 アピキー パラメータ。
両方のエンドポイントで必須: APIキーは必須です
通知/送信 そして 通知/リスト.
共通の概念
ターゲットモバイル
通知は、特定のモバイルデバイスに送信されます。 シドリストエンドポイントは、同じターゲットをフィルタリングできます。 識別者 または シド.
分散状態
- 分散=1 これは、通知が配信されたことを意味します。
- 分散=0 配布されていないことを意味します。
- 分散ステータス リターン 分散型 または 非配布.
日付とタイムゾーン
- 送信済み_* フィールドは通知の送信日時を表します GMT.
- 分散型_* フィールドは配布日時を表します GMT.
- *_at_unix フィールドはUnixタイムスタンプです。
リストエンドポイントの動作
- リストエンドポイントは常に最大数を返します 200 行。
- 結果は送信日時に基づいて新しい順から古い順に並べられます。
- 日付フィルターの使用 日付追加 内部的に露出しており、 日付_開始日 / 日付_.
エラー
| HTTP | エラー例 | 意味 |
|---|---|---|
| 400 | {"success":false,"message":"必須パラメータ「apikey」が不足しています。"} | 欠落または空 アピキー. |
| 400 | {"success":false,"message":"必須パラメータが不足しています: apikeyとsidは必須です。"} | ない シド の上 通知/送信. |
| 400 | {"success":false,"message":"必須パラメータ「message」が不足しています。"} | ない メッセージ の上 通知/送信. |
| 400 | {"success":false,"message":"日付の開始日時の形式が無効です。YYYY-MM-DD形式が必要です。"} | 無効 日付_開始日 フォーマット 通知/リスト. |
| 400 | {"success":false,"message":"無効な分散値です。許容値:0または1。"} | 無効 分散 フィルター値。 |
| 500 | {"success":false,"message":"DB接続に失敗しました。"} | データベース接続の問題です。 |
| 500 | {"success":false,"message":"クエリが失敗しました: ..."} | SQL / 実行エラー。 |
通知 – 送信
対象のモバイルデバイス向けに新しい通知を作成します。
終点
得る
役職
https://api.smsmobileapi.com/notification/send
クエリ/ボディパラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| アピキー | 弦 | 必須 API キー。 |
| シド | 弦 | 必須 モバイル端末のIDを標的とする。 |
| タイトル | 弦 | オプション 通知タイトル。デフォルト: 通知. |
| メッセージ | 弦 | 必須 通知メッセージの内容。 |
| タイプ | 弦 | オプション 通知タイプ。デフォルト: 通知. |
成功時の応答例
{ "success": true, "message": "通知が作成されました。", "id": 22087, "apikey": "YOUR_API_KEY", "sid": "508b004b4aadacc4" }
通知リスト
APIキーに関連付けられた最新の通知を取得します(オプションでフィルタリングも可能です)。
終点
得る
https://api.smsmobileapi.com/notification/list/
クエリパラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| アピキー | 弦 | 必須 API キー。 |
| 識別者 | 弦 | オプション 通知を対象のモバイル端末でフィルタリングします。 |
| シド | 弦 | オプション 別名 識別者. |
| 分散 | 0 | 1 | オプション 1 = 配布のみ、 0 = 配布のみではない。 |
| 日付_開始日 | 年-月-日 | オプション 送信日をこの日付以降で絞り込む。 |
| 日付_ | 年-月-日 | オプション 送信日を今日までで絞り込む。 |
リストエンドポイントは最大で 200 行を最新の通知が最初に来るように並べ替えます。
成功時の応答例
{ "success": true, "message": "通知が正常に取得されました。", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "通知", "message": "vers miano", "distribued": "1", "distribued_status": "distributed", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "2026-03-18", "sent_time_gmt": "10:15:03", "sent_at_gmt": "2026-03-18 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
応答フィールドを送信する
| 分野 | タイプ | 説明 |
|---|---|---|
| 成功 | ブール | リクエストのステータス。 |
| メッセージ | 弦 | 人間が読みやすい結果メッセージ。 |
| ID | 整数 | データベースに通知IDを作成しました。 |
| アピキー | 弦 | APIキーをエコーバックしました。 |
| シド | 弦 | 作成時に使用されたターゲットモバイルID。 |
応答フィールドの一覧
| 分野 | タイプ | 説明 |
|---|---|---|
| 成功 | ブール | リクエストのステータス。 |
| メッセージ | 弦 | 人間が読みやすい結果メッセージ。 |
| フィルター | 物体 | リクエストで使用されたフィルターをエコーしました。 |
| カウント | 整数 | 返送された通知の数。 |
| データ | 配列 | 通知一覧。 |
| データ[].識別子 | 弦 | 対象となるモバイル識別子。 |
| データ[].タイトル | 弦 | 通知タイトル。 |
| データ[].メッセージ | 弦 | 通知メッセージ。 |
| データ[].分散 | 弦 | 未配布のフラグ。 |
| データ[].distributed_status | 弦 | 分散型 または 非配布. |
| データ[].distributed_date_gmt | 弦 | 配信日時(グリニッジ標準時)。 |
| データ[].distributed_time_gmt | 弦 | 配信時間はグリニッジ標準時(GMT)です。 |
| データ[].distributed_at_gmt | 弦 | 配布日時の詳細はGMT(グリニッジ標準時)で示します。 |
| data[].distributed_at_unix | 整数|null | 配布日時をUnixタイムスタンプとして指定します。 |
| データ[].distributed_timezone | 弦 | いつも GMT. |
| データ[].sent_date_gmt | 弦 | 日付はGMTで送信してください。 |
| データ[].sent_time_gmt | 弦 | 時刻はGMTで送信してください。 |
| データ[].sent_at_gmt | 弦 | 送信日時(GMT)を完全記録します。 |
| data[].sent_at_unix | 整数|null | 日時をUnixタイムスタンプとして送信します。 |
| data[].sent_timezone | 弦 | いつも GMT. |
