ここから開始
4 つのステップで最初のリクエストを実行します
ダッシュボードからAPIキーをコピーしてアカウントを作成。
モバイルアプリをインストールし、デバイスがオンラインであることを確認します。
/sendsms/エンドポイントで1つのテストSMSを送信します。
返されたメッセージ ID を格納して、ログと配信状況を関連付けます。
オフィシャルモバイルアプリケーション
電話、ダッシュボード、API間の安全な橋。
SMS とコール操作は、接続された電話にインストールされている公式 SMSMobileAPI アプリを通過します。 アプリは、アカウントでデバイスを安全にペアリングし、認定イベントを同期し、モバイルネットワークをダッシュボードとREST APIにリンクします。
- 正式なGoogle PlayとApple App Storeの一覧で配布されたサインされたリリース
- GoogleとAppleプラットフォームのレビュー、署名、配布制御
- セキュアなデバイスペアリング、HTTPS の輸送および認証 API アクセス
- 有効にできるモバイル機能に必要な権限のみ
この API の WEBHOOK V2
ワークフローに必要なモバイルイベントだけを購読してください。
1つのデスティネーションがすべて受け取ることも、プロダクション、分析、運用アラートを分離することもできます。すべてのイベントには正確な名前が付いており、アプリケーションは予測可能に処理できます。
sms.api.submittedAPI を経由して提出された SMS
API リクエストが SMS 送信ジョブを作成しました。リクエストがプラットフォームに到達したことを確認するのに役立ちます。
sms.sentSMS が送信済み
接続されたモバイルが SMS の送信操作を確認しました。
sms.failedSMS が失敗
接続されたモバイル端末から SMS の送信エラーが返されました。
sms.receivedSMS を受信
接続されたモバイル端末が着信の SMS を同期しました。
sms.mobile.sentモバイルから送信された SMS
接続されたモバイルから手動で SMS が送信されました。
認証
認証情報をサーバー上に保持します
apikeyパラメーターでAPIキーをリクエストする。 OAuth2 クライアントの認証情報は、サーバー・ツー・サーバーの統合にも利用できます。 ブラウザコード、パブリックリポジトリ、サポートメッセージでプロダクションキーを公開しないでください。
歴史管理
安全に履歴をクリア:プレビュー、削除、進捗状況を追跡
これらのエンドポイントは、電話や外部サービスに対するメッセージではなく、APIキーの選択したサーバー履歴をクリアします。 口座の消去は行いません。 削除後に新規活動が出現する可能性があります。
request_idおよび再試行ガイドを読んで下さい
デフォルトでは、リンクされたレコードや処理レコードが表示されるままです。 統合や継続的な処理が動作を停止する可能性があることを承諾した場合、include_linked=1のみを使用してください。
request_idの仕組み
- action=preview でカウントをプレビューします。 request_id は不要で、レコードは削除されません。
- ユニークでユニークな生成 request_id 削除の削除、例えばa UUID. 送信する前に保存 action=delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
- retries、タイムアウト、HTTP 202 では、同じ API キー、履歴エンドポイント、request_id および include_linked 値を再利用できます。 エラー後に自動的に新しいIDを生成しないでください。
- completed=true が終了したら、動作が終了します。 ID を再利用すると、新規のレコードを削除した代わりに同じ結果が返されます。 新しく追加されたIDは、意図的に新しいクリーンアップのためにのみ使用してください。
request_idは、削除操作を識別します。, 個々のSMSではありません. 許可されたフォーマット: 16-128 ASCII 手紙、数字、ハイフンまたはアンダースコア。 暗号化で生成されるUUIDは、.randomUID() が適しています。
削除はバッチ単位で行われます。HTTP 202 と continue_required=true が返った場合は、3秒後に action=delete を再送してください。バックグラウンドのcronは動作しません。action=status は進捗を参照するだけで、HTTP 200 でも削除を続行しません。
削除とステータス例
開始する前に、サンプルrequest_idを独自の値に置き換えてください。 以下の削除リクエストは実際のアカウント履歴を変更します。プレビューされません。
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-sms-api/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"GET は action=preview か action=delete をまた受け入れます。 POST は推奨されます。URL パラメータはブラウザの履歴とサーバーログに漏れる可能性があります。 公開リンク、画像、または事前フェッチに削除URLを配置しないでください。
POST では、フォーム本体または JSON オブジェクトのすべてのパラメーターを、クエリ文字列に決して送信しません。 未知のパラメータは拒否されます。日付またはモバイルフィルタはサポートされていません。
歴史エンドポイントの認証
利用条件 apikey または Authorization: : : : Bearer 発行するアクセストークン SMSMobileAPI OAuth2. リフレッシュトークンやリフレッシュトークンを送らないでください。 API キーをキーとして Bearer トークン。 有効期限切れのトークンは拒否されます。
スコープが設定されている場合、history:read では、プレビュー/ステータスと history:delete も削除できます。 トークンとOAuthクライアントの両方の制限が適用されます。 スコープのないレガシートークンは、既存のアカウントアクセスを保持します。
OAuth2は、独自のプライマリAPIキーを選択します。 複数の主キーが存在する場合、apikey はアカウントに所属するキーを1つ選択します。 二次キーは、主要なキー履歴へのアクセスを許可しません。
継続する前に、応答を読む
count_deleteは、この操作で削除された累積番号です。 selected_at_startは初期選択です。 protected_at_startは除外されたレコードをカウントします。 preview.linked_or_processing を使用して、include_linked=1 がリンクされたレコードを数えるようにします。
{
"result": {
"error": 0,
"history": "sms-api",
"action": "delete",
"request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
"status": "processing",
"completed": false,
"count_delete": 100,
"total_before": 250,
"selected_at_start": 200,
"protected_at_start": 50,
"include_linked": 0,
"continue_required": true,
"message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
}
}- completed=true と 200 枚: 終了。 200プレビューまたはステータス応答だけでは完了が証明されていません。
- 400 INVALID_REQUEST_ID:フォーマットを点検して下さい。 404 REQUEST_NOT_FOUND: このID、APIキーおよび履歴には動作しません。
- 401: 無効または期限切れの認証情報。 403: 不十分なOAuthのスコープまたは無許可のアカウント。
- 409 HISTORY_BUSY:別のクリーンアップが実行され、元のクライアントから続行します。 409 INCLUDE_LINKED_CONFLICT:元のinclude_linked値を元通りに復元します。
- 409 OAUTH_ACCOUNT_AMBIGUOUS:このアカウントに所属するAPIキーを提供します。
- 503 またはネットワークの中断: いくつかのバッチは既に完了する可能性があります。 設定をチェックし、元のrequest_idで再試行します。 交換操作を自動的に作成しないでください。
ポスト・GET
SMS 送信
https://api.smsmobileapi.com/sendsms/接続された電話にメッセージをキューイングします。 長いメッセージや特殊な文字を含む場合に、POST が推奨されます。
トランザクションメッセージ、リマインダー、アラート、およびアプリケーション生成されたSMSにこれを使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
recipients |
携帯電話 | 必須 | 国際フォーマットの宛先番号。 |
message |
弦 | 必須 | メッセージを送信する GET を使うと URL がエンコードされます。 |
port |
1 | 2 | 任意 | 対応するAndroidデバイスにSIMポート、自動選択用に空のままに。 |
sIdentifiant |
弦 | 任意 | 特定の接続された電話SID;最初の利用可能なデバイスに空のままにします。 |
shorturl |
0 | 1 | 任意 | メッセージ内のURLを1つにまとめて短縮します。 |
sendsms |
0 | 1 | 任意 | SMS チャネルの旗。 省略時はデフォルトで1つに。 |
sendwa |
0 | 1 | 任意 | また、アカウントがサポートしているときにWhatsAppのリクエストも配信します。 |
encrypt_message |
はい | 任意 | 受信側保護読書のためのメッセージを暗号化します。 |
schedule_timestamp |
Unix 秒 | 任意 | 送信するメッセージが送信される UTC 時間。 |
リクエストの例
curl -X POST "https://api.smsmobileapi.com/sendsms/" \
-d "apikey=YOUR_API_KEY" \
-d "recipients=+1234567890" \
--data-urlencode "message=Your appointment is confirmed for tomorrow."
回答例
{
"result": {
"error": 0,
"sent": "1",
"id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25",
"note": "sent by mobile",
"datetime": "2026-03-20T21:07:44Z",
"port": null,
"send_with_whatsapp": "0"
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- API の応答が成功すると、メッセージがプラットフォームによって受け入れられることを意味します。 後で追跡するために、返された ID を保ちましょう。
- HTTP応答後にキャリアデリバリーとモバイル処理を行うことができます。
ポスト・GET
送信されていないSMSを再送信する
https://api.smsmobileapi.com/resend/現在エラー状態にあるメッセージを、メッセージにリトリートします。
送信されたログをチェックした後、別の試みの失敗したメッセージが対象であることを確認した後にこれを使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
guid |
弦 | 必須 | 送信またはログエンドポイントで返されたメッセージ GUID 。 |
リクエストの例
curl "https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE"
回答例
{
"result": {
"error": "0",
"sms": "resent with successfully",
"attempt": 1
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- エラーステータスのメッセージのみが再送信できます。
得る
APIから送信されたSMSをリスト
https://api.smsmobileapi.com/log/sent/sms/キュー、モバイル、エラー情報でSMS APIを通して送信されたメッセージを返します。
配達監視、サポート診断および調整のためにそれを使用して下さい。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
guid_message |
弦 | 任意 | 独自のGUIDで1つのメッセージを返します。 |
before |
タイムスタンプまたは参照 | 任意 | 指定したカーソルまたはタイムスタンプの前にメッセージを返します。 |
error_api |
0 | 1 | 任意 | エラー処理のAPIを1つだけ返すように設定します。 |
error_mobile |
0 | 1 | 任意 | 1 に設定して、モバイル送信エラーのみを返す。 |
keyword |
弦 | 任意 | 受信者番号またはメッセージテキストを検索します。 |
リクエストの例
curl "https://api.smsmobileapi.com/log/sent/sms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"
回答例
{
"result": {
"error": "0",
"sms": [{
"sIdentifiantPhone": "508b004b4aadacc4",
"recipients": "+1234567890",
"sms": "Test message",
"guid_message": "MESSAGE_GUID",
"send_from_mobile": 1,
"error_api": "",
"send_from_mobile_erreur": ""
}]
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑
得る
携帯電話のSMS同期をリスト
https://api.smsmobileapi.com/log/sent/frommobile/プラットフォームで同期したモバイルで、SMSを物理的に送信。
携帯電話やAPIを介してメッセージが発信されるときに使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
date |
年-月-日 | 任意 | 正確な日付を 1 つろ過して下さい。 |
date_from |
年-月-日 | 任意 | 開始日の範囲。 |
date_to |
年-月-日 | 任意 | 期限切れ。 |
period |
列挙型 | 任意 | 昨日、Last 24h、last 3days、Last 7days。 |
number |
携帯電話 | 任意 | 受信者によるフィルタリング |
sIdentifiant |
弦 | 任意 | 接続されたモバイルSIDでフィルタリングします。 |
message |
弦 | 任意 | メッセージ内容でフィルタリングします。 |
search |
弦 | 任意 | モバイル、番号、メッセージ、タイムスタンプを横断してグローバル検索。 |
sort_by |
列挙型 | 任意 | sIdentifiant、番号、メッセージ、Mobile date ms、Mobile date formatted、またはsychro time。 |
sort_order |
ASC | ディスク | 任意 | 並び替え方向。 |
limit |
整数 | 任意 | 最大200レコード。 |
リクエストの例
curl "https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&period=last_7days&limit=200"
回答例
{
"result": {
"error": "0",
"count": 1,
"history_limit_days": 7,
"sms": [{
"sIdentifiant": "508b004b4aadacc4",
"number": "+15551234567",
"message": "Appointment confirmed.",
"mobile_date_ms": 1774041004692,
"synchro_time": "2026-03-20 21:10:05"
}]
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- Androidアプリ4.1.20以降が必要です。アプリで有効にする必要があります。
- 同期履歴の7日間最大7日間を返却します。
得る
リストはSMSを受け取りました
https://api.smsmobileapi.com/getsms/接続された電話から同期するSMSを着信させます。
受信トレイ、受信トレイをビルドしたり、Webhook 中断後にメッセージを返信したり、復元したりするために使用してください。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
sIdentifiantPhone |
弦 | 任意 | SMSを受信した電話によるフィルタ。 |
after_timestamp_unix |
Unix 秒 | 任意 | タイムスタンプが受け取ったら、メッセージが返されます。 |
onlyunread |
はい | 任意 | API の状態で読み込まれるようなメッセージだけを返します。 |
リクエストの例
curl "https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY&onlyunread=yes"
回答例
{
"result": {
"error": "",
"sms": [{
"id": 466340,
"sIdentifiantPhone": "508b004b4aadacc4",
"timestamp_unix": 1774041814,
"message": "Please call us back.",
"number": "+15551234567",
"guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122",
"alias": null
}]
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑
ポスト・GET
受信したSMSを読み取りとしてマークする
https://api.smsmobileapi.com/getsms/set-read/SMSMobileAPI API状態で読み込まれたメッセージが1つマークされます。
応募者が受信したメッセージを処理した後に使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
guid_message |
弦 | 必須 | 受信したSMSのGUID。 |
リクエストの例
curl "https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- 携帯電話のメッセージングアプリケーション内での読み取り状態を変更しません。
ポスト・GET
受信したSMSエイリアスを更新する
https://api.smsmobileapi.com/getsms/update/受信したSMSに関連付けられているエイリアスを追加、変更、またはクリアします。
エイリアスを使用して、連絡先名またはアプリケーションラベルをメッセージに添付します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
guid |
弦 | 必須 | 受信したSMSのGUID。 |
alias |
弦 | 必須 | 新規エイリアス。 空の値をクリアしてクリアします。 |
リクエストの例
curl "https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID&alias=John%20Doe"
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑
ポスト・GET
SMSサーバーログを削除します
https://api.smsmobileapi.com/deletesms/SMSMobileAPIサーバーログからSMSレコードを削除します。
特定の記録されたメッセージの保持ワークフローや削除に使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
guid_message |
弦 | 任意 | GUID で 1 つのメッセージを削除します。 |
date_start |
年-月-日 | 任意 | レコードをこの日付から削除します。 |
date_end |
年-月-日 | 任意 | date start では、削除範囲を制限します。 |
リクエストの例
curl "https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"
回答例
{
"result": {
"error": null,
"count_delete": 1
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- サーバログエントリのみを削除します。 モバイルデバイスに保存されているメッセージは削除されません。
- これを破壊し、フィルタを呼び出してから確認する。
得る
SMSの会話一覧
https://api.smsmobileapi.com/conversation/sms/list/メッセージを発信し、発信するグループを電話番号で会話に発信します。
チャットビュー、最近の会話ウィジェット、サポートタイムラインに使用できます。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
origineConversation |
郵送・発送 | 必須 | 開始した会話を識別するために使用されるデータセット。 |
numero |
携帯電話 | 任意 | ワンの電話番号の会話を返します。 |
date_from |
日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・祝日 | 任意 | メッセージ範囲の開始 |
date_to |
日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・日・祝日 | 任意 | メッセージ範囲の終了。 |
sort |
ASC | ディスク | 任意 | 会話順序; デフォルト DESC. |
limit |
整数 | 任意 | numero が省略されたときの会話制限; デフォルト 20. |
resume |
0 | 1 | 任意 | 1 に設定すると、会話ごとの最新のメッセージのみが返されます。 |
resume_line_how |
整数 | 任意 | 会話あたりのメッセージ数: 履歴書 = 1 で |
リクエストの例
curl "https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&resume=1&resume_line_how=3"
回答例
{
"success": true,
"origineConversation": "received",
"conversations": [{
"phone_number": "+15551234567",
"contact_alias": "John Doe",
"messages": [{
"direction": "incoming",
"message_id": "msg_1001",
"timestamp_utc": "2026-03-13T08:45:12Z",
"message": "I need more information.",
"status": "received",
"mobile_sid": "device_sid_1"
}]
}]
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑
得る
接続されているモバイルの一覧
https://api.smsmobileapi.com/gateway/mobile/list/SMSゲートウェイアカウントに接続された電話をリストします。
送信機、デバイスの状態を表示したり、ゲートウェイフリートを監査したりするために使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
sid |
弦 | 任意 | 正確なモバイルSIDを返します。 |
search |
弦 | 任意 | SID、日付、バッテリー、バージョン、ラベル、関連フィールドを検索します。 |
リクエストの例
curl "https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY"
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑
ポスト・GET
接続されたモバイルを更新する
https://api.smsmobileapi.com/gateway/mobile/update/接続されたデバイスの人読みラベルまたは電話番号を更新します。
複数の電話の設置で意味のあるデバイスラベルを保つために使用します。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
sid |
弦 | 必須 | デバイスSID。 |
label |
弦 | 必須 | 新しいラベル。意図的に空にすることができます。 |
phone_number |
携帯電話 | 任意 | 新しい電話番号メタデータ。 |
リクエストの例
curl "https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=DEVICE_SID&label=OfficePhone"
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑
ポスト・GET
接続されているモバイルを削除する
https://api.smsmobileapi.com/gateway/mobile/delete/接続されたモバイルとそのゲートウェイの履歴行を削除します。
携帯電話がアカウントから永久に削除する必要がある場合にのみ使用してください。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 必須 | 口座名 API キー |
sid |
弦 | 必須 | デバイスをSIDで削除します。 |
リクエストの例
curl "https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=DEVICE_SID"
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- この操作は、SIDに関連付けられているデバイス履歴を削除します。 呼び出し前にデバイスを確認します。
投資ポスト
網の網によるSMSを受け取る
Your HTTPS endpointSMSMobileAPIは、SMSを受信したときに、設定されたURLにJSONリクエストを送信します。
頻繁なポーリングの代りに実時間処理のためのwebhooksを使用して下さい。
受信機例
<?php
$payload = json_decode(file_get_contents('php://input'), true);
if (!is_array($payload) || empty($payload['guid'])) {
http_response_code(400);
exit('Invalid payload');
}
// Queue the event, then acknowledge quickly.
http_response_code(200);
echo 'OK';
回答例
{
"date": "2026-03-20",
"hour": "10:15:00",
"time_received": "2026-03-20 10:14:50",
"message": "Hello, this is a test.",
"number": "+123456789",
"guid": "abcde12345"
}
このページでは、HTTPSのURLでイベントを受け取ります。 上記受信機の例を使用して、接続された電話にSMSを送ってテストします。
- ダッシュボード → Webhook 設定で公開する HTTPS URL を設定します。
- HTTP 200を素早く返し、イベントを非同期的に処理します。
- guid を使って、レトリーを解読する。
ポスト・GET
API経由で送信したSMSの履歴を消去
https://api.smsmobileapi.com/delete-history-sms-api/API から提出された SMS のサーバーレコードをクリアします。 既に電話で収集したメッセージを呼び出すことはありません。
プレビューを最初に使用し、カウントを確認し、明示的に削除を要求します。 これにより、日付、電話、メッセージフィルタなしで、APIキーの選択した履歴全体が消去されます。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 任意 | OAuth2 なしで要求して下さい。 OAuth2 では、同じアカウントに属する API キーをオプションで選択します。 |
action |
プレビュー | 削除 | ステータス | 任意 | preview は削除せずに件数を数え、delete は削除を開始または続行し、status は進捗の参照のみを行います。APIの既定値は delete、このテストツールの既定値は preview です。 |
include_linked |
0 | 1 | 任意 | デフォルト 0: 記録をリンクまたは処理し続けます。 1 を設定して、統合を破るリスクを伴います。 削除を継続する際には、この値を変更しないようにしてください。 |
request_id |
弦 | 任意 | delete と status では必須、preview では任意です。16~128文字のASCII英字、数字、ハイフン (-)、アンダースコア (_) を使用してください。新しい削除操作ごとに一意のIDを作成し、再試行時は同じIDを保持してください。メッセージIDやAPIキーではありません。 |
リクエストの例
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=preview" -d "include_linked=0"
削除とステータス例
開始する前に、サンプルrequest_idを独自の値に置き換えてください。 以下の削除リクエストは実際のアカウント履歴を変更します。プレビューされません。
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-sms-api/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"回答例
{
"result": {
"error": 0,
"history": "sms-api",
"action": "preview",
"total": 120,
"simple": 100,
"linked_or_processing": 20,
"selected": 100,
"include_linked": 0,
"operation_in_progress": false,
"active_include_linked": null
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- 上記は、削除ではなくプレビューです。 カウントは、決定的な選択が削除が始まるときに固定されます。
- include_linked=1は、GHL、Zapier、自動化、リンクの解除、または配送追跡を中断することがあります。 決してアカウントの所有権やストレージの完全性チェックを迂回しません。
ポスト・GET
携帯電話から送信したSMSの履歴を消去
https://api.smsmobileapi.com/delete-history-sms-mobile/携帯電話に保存されたメッセージではなく、モバイルから送信されたSMSの同期レコードをクリアします。
プレビューを最初に使用し、カウントを確認し、明示的に削除を要求します。 これにより、日付、電話、メッセージフィルタなしで、APIキーの選択した履歴全体が消去されます。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 任意 | OAuth2 なしで要求して下さい。 OAuth2 では、同じアカウントに属する API キーをオプションで選択します。 |
action |
プレビュー | 削除 | ステータス | 任意 | preview は削除せずに件数を数え、delete は削除を開始または続行し、status は進捗の参照のみを行います。APIの既定値は delete、このテストツールの既定値は preview です。 |
include_linked |
0 | 1 | 任意 | デフォルト 0: 記録をリンクまたは処理し続けます。 1 を設定して、統合を破るリスクを伴います。 削除を継続する際には、この値を変更しないようにしてください。 |
request_id |
弦 | 任意 | delete と status では必須、preview では任意です。16~128文字のASCII英字、数字、ハイフン (-)、アンダースコア (_) を使用してください。新しい削除操作ごとに一意のIDを作成し、再試行時は同じIDを保持してください。メッセージIDやAPIキーではありません。 |
リクエストの例
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=preview" -d "include_linked=0"
削除とステータス例
開始する前に、サンプルrequest_idを独自の値に置き換えてください。 以下の削除リクエストは実際のアカウント履歴を変更します。プレビューされません。
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-sms-mobile/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"回答例
{
"result": {
"error": 0,
"history": "sms-mobile",
"action": "preview",
"total": 120,
"simple": 100,
"linked_or_processing": 20,
"selected": 100,
"include_linked": 0,
"operation_in_progress": false,
"active_include_linked": null
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- 上記は、削除ではなくプレビューです。 カウントは、決定的な選択が削除が始まるときに固定されます。
- include_linked=1は、GHL、Zapier、自動化、リンクの解除、または配送追跡を中断することがあります。 決してアカウントの所有権やストレージの完全性チェックを迂回しません。
ポスト・GET
受信SMSの履歴を消去
https://api.smsmobileapi.com/delete-history-sms-received/SMS の受信サーバレコードをクリアします。 統合および自動化レコードはデフォルトで保護されます。
プレビューを最初に使用し、カウントを確認し、明示的に削除を要求します。 これにより、日付、電話、メッセージフィルタなしで、APIキーの選択した履歴全体が消去されます。
パラメータ
| 名前 | タイプ | 要件 | 説明 |
|---|---|---|---|
apikey |
弦 | 任意 | OAuth2 なしで要求して下さい。 OAuth2 では、同じアカウントに属する API キーをオプションで選択します。 |
action |
プレビュー | 削除 | ステータス | 任意 | preview は削除せずに件数を数え、delete は削除を開始または続行し、status は進捗の参照のみを行います。APIの既定値は delete、このテストツールの既定値は preview です。 |
include_linked |
0 | 1 | 任意 | デフォルト 0: 記録をリンクまたは処理し続けます。 1 を設定して、統合を破るリスクを伴います。 削除を継続する際には、この値を変更しないようにしてください。 |
request_id |
弦 | 任意 | delete と status では必須、preview では任意です。16~128文字のASCII英字、数字、ハイフン (-)、アンダースコア (_) を使用してください。新しい削除操作ごとに一意のIDを作成し、再試行時は同じIDを保持してください。メッセージIDやAPIキーではありません。 |
リクエストの例
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-received/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=preview" -d "include_linked=0"
削除とステータス例
開始する前に、サンプルrequest_idを独自の値に置き換えてください。 以下の削除リクエストは実際のアカウント履歴を変更します。プレビューされません。
curl -X POST "https://api.smsmobileapi.com/delete-history-sms-received/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-sms-received/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-sms-received/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"回答例
{
"result": {
"error": 0,
"history": "sms-received",
"action": "preview",
"total": 120,
"simple": 100,
"linked_or_processing": 20,
"selected": 100,
"include_linked": 0,
"operation_in_progress": false,
"active_include_linked": null
}
}
これを実行したいrequest?インタラクティブなテスターをアンロックするために、ページの上部にあるAPIキーを接続します。
接続キー ↑- 上記は、削除ではなくプレビューです。 カウントは、決定的な選択が削除が始まるときに固定されます。
- include_linked=1は、GHL、Zapier、自動化、リンクの解除、または配送追跡を中断することがあります。 決してアカウントの所有権やストレージの完全性チェックを迂回しません。
トラブルシューティング
エラーと安全な再試行
再試行する前に、HTTP ステータスと JSON エラー フィールドを読み取ります。最初にリクエストを修正せずに、検証または認証の失敗を再試行しないでください。
| HTTP | コード | 対処方法 |
|---|---|---|
| 400 | missing_parameter | 必須パラメータは空か不在です。 エンドポイントのパラメータテーブルを確認します。 |
| 403 | invalid_apikey | APIキーは、要求された機能の認証が不明、期限切れ、または承認されていない。 |
| 429 | too_many_requests | リクエストはすぐに到着します。 待ってから、指数関数的なバックオフで再試行します。 |
| 500 | server_error | リクエストをクリアできないサービス 応答を保ち、主張するかどうかサポートに連絡して下さい。 |
ヘルプが必要ですか?
シークレットではなくリクエスト コンテキストを提供します。
エンドポイント、タイムスタンプ、HTTP ステータス、サニタイズされたレスポンスを共有します。 API キー、トークン、プライベート メッセージ コンテンツは決して含めないでください。


