生産準備のモバイルインフラHTTPS API・Android・iOS・ドキュメントエンドツーエンドプラットフォームを探索する
プラットフォームAPIファーストアーキテクチャセキュアなデバイスペアリング配信可視性多デバイス制御版文書
開発者ハブ/SMS API

SMS · 13 documented operations

SMS API documentation

Send and receive SMS, inspect delivery logs, build conversations and manage connected mobile gateways.

A smartphone connected to SMS and cloud gateway infrastructure
REST ベース URLhttps://api.smsmobileapi.com

JSON 応答 · HTTPS が必要 · UTF-8

API キーを接続します

一度接続し、SMS、通話、通知、WhatsApp、電子メール全体でエンドポイントをテストします。

ここから開始

4 つのステップで最初のリクエストを実行します

1

Create an account and copy the API key from the dashboard.

2

Install the mobile app and confirm that the device is online.

3

Send one test SMS with the /sendsms/ endpoint.

4

Store the returned message ID to correlate logs and delivery status.

The secure SMSMobileAPI mobile app connecting a phone to the web dashboard and REST API for SMS and call operations
Encrypted mobile-to-platform connection

Official mobile application

The secure bridge between your phone, dashboard and API.

SMS and call operations pass through the official SMSMobileAPI app installed on your connected phone. The app securely pairs the device with your account, synchronizes authorized events and links the mobile network to the dashboard and REST API.

1Mobile appPairs the phone and its SIM 2Encrypted linkAuthenticates and protects data in transit 3Dashboard & APIControls workflows and activity
  • Signed releases distributed through the official Google Play and Apple App Store listings
  • Google and Apple platform review, signing and distribution controls
  • Secure device pairing, HTTPS transport and authenticated API access
  • Only the permissions required for the mobile features you enable
Get the official SMSMobileAPI app on Google Play Download the official SMSMobileAPI app on the Apple App Store
Capabilities depend on the permissions and background access allowed by Android or iOS.

認証

認証情報をサーバー上に保持します

Every request accepts an API key through the apikey parameter. OAuth2 client credentials are also available for server-to-server integrations. Never expose a production key in browser code, public repositories or support messages.

POST · GET

Send an SMS

#
ENDPOINThttps://api.smsmobileapi.com/sendsms/

Queues a message on a connected phone. POST is recommended when the message is long or contains special characters.

いつ使用するか

Use this for transactional messages, reminders, alerts and application-generated SMS.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
recipients phone 必須 Destination number in international format.
message 必須 Message body. URL-encode it when using GET.
port 1 | 2 オプション SIM port on compatible Android devices; leave empty for automatic selection.
sIdentifiant オプション Specific connected phone SID; leave empty for the first available device.
shorturl 0 | 1 オプション Set to 1 to shorten URLs found in the message.
sendsms 0 | 1 オプション SMS channel flag. Defaults to 1 when omitted.
sendwa 0 | 1 オプション Also request WhatsApp delivery when the account supports it.
encrypt_message はい オプション Encrypt the message for recipient-side protected reading.
schedule_timestamp Unix seconds オプション UTC time from which the message may be sent.

リクエストの例

カール
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."

回答例

JSON
{
  "result": {
    "error": 0,
    "sent": "1",
    "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25",
    "note": "sent by mobile",
    "datetime": "2026-03-20T21:07:44Z",
    "port": null,
    "send_with_whatsapp": "0"
  }
}

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
Good to know
  • A successful API response means the message was accepted by the platform; keep the returned id for later tracking.
  • Carrier delivery and mobile processing can happen after the HTTP response.
POST · GET

送信されていないSMSを再送信する

#
ENDPOINThttps://api.smsmobileapi.com/resend/

Retries a message that is currently in an error state.

いつ使用するか

Use this after checking the sent log and confirming that a failed message is eligible for another attempt.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
guid 必須 The message GUID returned by the send or log endpoint.

リクエストの例

カール
curl "https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE"

回答例

JSON
{
  "result": {
    "error": "0",
    "sms": "resent with successfully",
    "attempt": 1
  }
}

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
Good to know
  • Only messages with an error status can be resent.
得る

List SMS sent from the API

#
ENDPOINThttps://api.smsmobileapi.com/log/sent/sms/

Returns messages submitted through the SMS API with queue, mobile and error information.

いつ使用するか

Use it for delivery monitoring, support diagnostics and reconciliation.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
guid_message オプション Return one message by its unique GUID.
before timestamp or reference オプション Return messages before the supplied cursor or timestamp.
error_api 0 | 1 オプション Set to 1 to return API processing errors only.
error_mobile 0 | 1 オプション Set to 1 to return mobile sending errors only.
keyword オプション Search the recipient number or message text.

リクエストの例

カール
curl "https://api.smsmobileapi.com/log/sent/sms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

回答例

JSON
{
  "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? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
得る

List SMS synchronized from a phone

#
ENDPOINThttps://api.smsmobileapi.com/log/sent/frommobile/

Lists SMS physically sent by a mobile and synchronized with the platform.

いつ使用するか

Use it when messages may originate on the phone as well as through the API.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
date 年-月-日 オプション Filter one exact date.
date_from 年-月-日 オプション Start of a date range.
date_to 年-月-日 オプション End of a date range.
period 列挙型 オプション today, yesterday, last_24h, last_3days or last_7days.
number phone オプション Filter by recipient.
sIdentifiant オプション Filter by connected mobile SID.
message オプション Filter by message content.
search オプション Global search across mobile, number, message and timestamps.
sort_by 列挙型 オプション sIdentifiant, number, message, mobile_date_ms, mobile_date_formatted or synchro_time.
sort_order ASC | DESC オプション Sort direction.
limit 整数 オプション Maximum 200 records.

リクエストの例

カール
curl "https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&period=last_7days&limit=200"

回答例

JSON
{
  "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? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
Good to know
  • Requires Android app 4.1.20 or newer and must be enabled in the app.
  • This endpoint returns a maximum of seven days of synchronized history.
得る

List received SMS

#
ENDPOINThttps://api.smsmobileapi.com/getsms/

Returns incoming SMS synchronized from connected phones.

いつ使用するか

Use it to build an inbox, poll for replies or recover messages after a webhook interruption.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
sIdentifiantPhone オプション Filter by the phone that received the SMS.
after_timestamp_unix Unix seconds オプション Return messages received after this timestamp.
onlyunread はい オプション Return only messages not marked as read in API state.

リクエストの例

カール
curl "https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY&onlyunread=yes"

回答例

JSON
{
  "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? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
POST · GET

Mark a received SMS as read

#
ENDPOINThttps://api.smsmobileapi.com/getsms/set-read/

Marks one received message as read in SMSMobileAPI API state.

いつ使用するか

Use this after your application has processed an incoming message.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
guid_message 必須 GUID of the received SMS.

リクエストの例

カール
curl "https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
Good to know
  • This does not change the read state inside the phone messaging application.
POST · GET

Update a received SMS alias

#
ENDPOINThttps://api.smsmobileapi.com/getsms/update/

Adds, changes or clears the alias associated with a received SMS.

いつ使用するか

Use aliases to attach a contact name or application label to a message.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
guid 必須 GUID of the received SMS.
alias 必須 New alias. Send an empty value to clear it.

リクエストの例

カール
curl "https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID&alias=John%20Doe"

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
POST · GET

Delete SMS server logs

#
ENDPOINThttps://api.smsmobileapi.com/deletesms/

Deletes SMS records from the SMSMobileAPI server log.

いつ使用するか

Use it for retention workflows or removal of a specific logged message.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
guid_message オプション Delete one message by GUID.
date_start 年-月-日 オプション Delete records from this date.
date_end 年-月-日 オプション With date_start, limits the deletion range.

リクエストの例

カール
curl "https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

回答例

JSON
{
  "result": {
    "error": null,
    "count_delete": 1
  }
}

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
Good to know
  • This deletes server log entries only. It does not delete messages stored on the mobile device.
  • Treat this operation as destructive and verify filters before calling it.
得る

SMSの会話一覧

#
ENDPOINThttps://api.smsmobileapi.com/conversation/sms/list/

Groups incoming and outgoing messages into conversations by phone number.

いつ使用するか

Use it for chat views, recent conversation widgets and support timelines.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
origineConversation received | sent 必須 Dataset used to identify the starting conversations.
numero phone オプション Return one phone-number conversation.
date_from date or datetime オプション Start of the message range.
date_to date or datetime オプション End of the message range.
sort ASC | DESC オプション Conversation order; default DESC.
limit 整数 オプション Conversation limit when numero is omitted; default 20.
resume 0 | 1 オプション Set to 1 to return only the latest messages per conversation.
resume_line_how 整数 オプション Number of messages per conversation when resume=1.

リクエストの例

カール
curl "https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&resume=1&resume_line_how=3"

回答例

JSON
{
  "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? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
得る

接続されているモバイルの一覧

#
ENDPOINThttps://api.smsmobileapi.com/gateway/mobile/list/

Lists phones connected to the SMS gateway account.

いつ使用するか

Use it to select a sender, display device status or audit a gateway fleet.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
sid オプション Return one exact mobile SID.
search オプション Search SID, date, battery, version, label and related fields.

リクエストの例

カール
curl "https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY"

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
POST · GET

Update a connected mobile

#
ENDPOINThttps://api.smsmobileapi.com/gateway/mobile/update/

Updates the human-readable label or phone number of a connected device.

いつ使用するか

Use it to keep device labels meaningful in multi-phone installations.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
sid 必須 The device SID.
label 必須 New label; it may be intentionally empty.
phone_number phone オプション New phone-number metadata.

リクエストの例

カール
curl "https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=DEVICE_SID&label=OfficePhone"

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
POST · GET

接続されているモバイルを削除する

#
ENDPOINThttps://api.smsmobileapi.com/gateway/mobile/delete/

Removes a connected mobile and its gateway history rows.

いつ使用するか

Use only when a phone must be permanently removed from the account.

パラメータ

名前タイプ要件説明
apikey 必須 Your account API key.
sid 必須 SID of the device to remove.

リクエストの例

カール
curl "https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=DEVICE_SID"

これを実行したいrequest? Connect your API key at the top of the page to unlock the interactive tester.

接続キー ↑
Good to know
  • This operation removes device history associated with the SID. Confirm the device before calling it.
INBOUND POST

Receive SMS by webhook

#
DESTINATIONYour HTTPS endpoint

SMSMobileAPI sends a JSON request to your configured URL whenever an SMS is received.

いつ使用するか

Use webhooks for real-time processing instead of frequent polling.

Receiver example

PHP 8
<?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';

回答例

JSON
{
  "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"
}
Inbound endpoint

This endpoint receives events at your own HTTPS URL. Use the receiver example above, then send an SMS to your connected phone to test it.

Good to know
  • Configure the public HTTPS URL in Dashboard → Webhook Settings.
  • Return HTTP 200 quickly and process the event asynchronously.
  • Deduplicate retries using guid.

トラブルシューティング

エラーと安全な再試行

再試行する前に、HTTP ステータスと JSON エラー フィールドを読み取ります。最初にリクエストを修正せずに、検証または認証の失敗を再試行しないでください。

HTTPコード対処方法
400missing_parameterA required parameter is empty or absent. Check the parameter table for the endpoint.
403invalid_apikeyThe API key is unknown, expired or not authorized for the requested feature.
429too_many_requestsRequests are arriving too quickly. Wait, then retry with exponential backoff.
500server_errorThe service could not complete the request. Keep the response and contact support if it persists.
再試行ルール一時的な 429 応答と 5xx 応答のみを再試行します。 1 秒後に開始し、2 秒、4 秒、8 秒に戻ります。

ヘルプが必要ですか?

シークレットではなくリクエスト コンテキストを提供します。

エンドポイント、タイムスタンプ、HTTP ステータス、サニタイズされたレスポンスを共有します。 API キー、トークン、プライベート メッセージ コンテンツは決して含めないでください。

API サポートに問い合わせる →