通話管理APIドキュメント
これらのエンドポイントを使用すると、 不在着信, 着信応答、 そして 発信通話 SMSMobileAPI モバイル アプリからダッシュボード + API に同期されます。
重要:モバイルアプリがバックグラウンドで動作している場合、携帯電話のシステムにより同期に遅延(最大10分程度)が生じることがあります。必要に応じて、いつでもアプリを開いて手動で同期できます。
ヘルプが必要ですか? api@smsmobileapi.com
クイックスタート
ベースURL
得る https://api.smsmobileapi.com
以下のすべてのエンドポイントは次のように文書化されています。 得る リクエスト。置き換え あなたのAPIキー 実際のキーを使用します(公開しないでください)。
例
https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY を取得します。
GET https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
GET https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=3247&date_from_ms=1700000000000&date_to_ms=1700864000000
認証
通話管理エンドポイントは、 アピキー クエリパラメータ。
サブスクリプションの検証: 受信/送信エンドポイントはAPIキーを検証し、サブスクリプションの有効性を確認します(日付制限 >= CURDATE())。期限が切れた場合は、 api_expired.
共通の概念
ページネーション
使用 制限 そして オフセット 結果をページ区切りします。
タイムスタンプ
- 通話日(ミリ秒) UNIXタイムスタンプです ミリ秒.
- 呼び出し日時utc UTC 日時文字列 (データベース フィールド) として保存されます。
- 不在着信の場合、APIはフォーマットされた 日付 文字列(ミリ秒の値から派生)。
検索
- 不在着信: 検索 番号または名前と一致します。
- 着信/発信: q マッチ 電話番号 または キャッシュ名.
ソート(受信/送信のみ)
ソートは以下によって制御されます 並べ替え + ソートディレクトリ (ホワイトリストに登録されたフィールドのみ)。不在着信は常に最新のものから順に並べられます。
エラー
| HTTP | エラー例 | 意味 |
|---|---|---|
| 400 | {"成功":false,"エラー":"apikeyがありません"} | 欠落または空 アピキー. |
| 403 | {"成功":false,"エラー":"無効なAPIキー"} | API キーが見つからない / 認識されません。 |
| 403 | {"成功":false,"エラー":"api_expired"} | サブスクリプションの有効期限が切れています(日付制限 (今日以前です)。 |
| 500 | {"成功":false,"エラー":"server_error","詳細":"..."} | サーバー エラー (データベース、SQL、例外)。 |
注: 不在着信エンドポイントは次のようなメッセージも返すことができます。 apikeyがありません または状況に応じて SQL 準備エラーが発生します。
不在着信 – リスト
モバイル デバイスから同期された不在着信を取得します。
終点
得る https://api.smsmobileapi.com/call/missed/list/
クエリパラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| アピキー | 弦 | 必須 携帯電話にリンクされた API キー。 |
| オフセット | 整数 | オプション ページ区切りオフセット(デフォルト: 0). |
| 制限 | 整数 | オプション 最大行数(デフォルト: 100、最大: 500). |
| 検索 | 弦 | オプション 番号または名前 (SQL LIKE) で検索します。 |
| 開始日 | 年-月-日 | オプション この日 (00:00:00) からフィルタリングします。 |
| 日付終了 | 年-月-日 | オプション この日(23:59:59)までフィルタリングします。 |
着信 – リスト
モバイル デバイスから同期された着信応答を取得します。
終点
得る https://api.smsmobileapi.com/call/incoming/list/
クエリパラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| アピキー | 弦 | 必須 API キー (サブスクリプションに対して検証済み)。 |
| 制限 | 整数 | オプション ページあたりの行数(デフォルト: 50、最大: 200). |
| オフセット | 整数 | オプション ページ区切りオフセット(デフォルト: 0). |
| 並べ替え | 弦 | オプション 許可された: 通話日(ミリ秒) 呼び出し日時utc 期間_秒 電話番号 作成日時 キャッシュ名 地理位置情報 |
| ソートディレクトリ | 昇順|降順 | オプション デフォルト: 説明. |
| 日付からミリ秒 | 整数(ミリ秒) | オプション フィルター call_date_ms >= date_from_ms. |
| 日付からミリ秒 | 整数(ミリ秒) | オプション フィルター call_date_ms <= date_to_ms. |
| q | 弦 | オプション 検索 電話番号 または キャッシュ名 (のように)。 |
発信通話 – リスト
モバイル デバイスから同期された発信通話を取得します。
終点
得る https://api.smsmobileapi.com/call/outgoing/list/
クエリパラメータ
着信通話と同じパラメータと動作。
| パラメータ | タイプ | 説明 |
|---|---|---|
| アピキー | 弦 | 必須 API キー (サブスクリプションに対して検証済み)。 |
| 制限 | 整数 | オプション ページあたりの行数(デフォルト: 50、最大: 200). |
| オフセット | 整数 | オプション ページ区切りオフセット(デフォルト: 0). |
| 並べ替え | 弦 | オプション 許可された: 通話日(ミリ秒) 呼び出し日時utc 期間_秒 電話番号 作成日時 キャッシュ名 地理位置情報 |
| ソートディレクトリ | 昇順|降順 | オプション デフォルト: 説明. |
| 日付からミリ秒 | 整数(ミリ秒) | オプション フィルター call_date_ms >= date_from_ms. |
| 日付からミリ秒 | 整数(ミリ秒) | オプション フィルター call_date_ms <= date_to_ms. |
| q | 弦 | オプション 検索 電話番号 または キャッシュ名 (のように)。 |
不在着信フィールド
| 分野 | タイプ | 説明 |
|---|---|---|
| 成功 | ブール | リクエストのステータス。 |
| オフセット | 整数 | ページ区切りオフセットが返されます。 |
| 制限 | 整数 | ページ区切りの制限が返されました。 |
| カウント | 整数 | 返される行数 データ. |
| データ | 配列 | 不在着信のリスト。 |
| データ[].数値 | 弦 | 発信者の電話番号。 |
| データ[].名前 | 弦 | キャッシュされた連絡先名(空の場合もあります)。 |
| データ[].日付 | 弦 | ミリ秒のタイムスタンプから派生したフォーマットされた日時文字列。 |
受信/送信フィールド
| 分野 | タイプ | 説明 |
|---|---|---|
| 成功 | ブール | リクエストのステータス。 |
| アピキー | 弦 | API によってエコーバックされました (キー)。 |
| 制限 | 整数 | 返されるページあたりの行数。 |
| オフセット | 整数 | ページ区切りオフセットが返されます。 |
| 並べ替え | 弦 | 並べ替えフィールドを適用しました。 |
| ソートディレクトリ | 弦 | 並べ替えの方向を適用しました。 |
| フィルター | 物体 | エコーフィルター(日付からミリ秒, 日付からミリ秒, q). |
| カウント | 整数 | 返される行数 行. |
| 行 | 配列 | 通話のリスト。 |
| rows[].電話番号 | 弦 | 電話番号。 |
| 行[].キャッシュ名 | 文字列|null | キャッシュされた連絡先名 (null にすることもできます)。 |
| 行[].call_date_ms | 整数 | 呼び出しタイムスタンプ(ミリ秒単位)。 |
| 行[].call_datetime_utc | 弦 | UTC 日時フィールド (データベース)。 |
| 行[].duration_sec | 整数 | 秒単位の継続時間。 |
| 行[].geo_location | 文字列|null | 地理的位置ラベル (null/空でも可)。 |
| 行[].create_at | 弦 | サーバー挿入タイムスタンプ。 |
