ドキュメント

最初のメッセージを送信します 午後に

SMS の送信、追跡、受信のためのプレーンな REST API (トークン認証、リアルタイム Webhook、SDK)。学ぶべき珍しいものは何もありません。

クイックスタート

3 つの動き、配信開始

すべての統合は、認証、送信、追跡という同じ短い弧を描きます。

01 · 認証するトークン: sk_live_9f2a7c10コンテンツタイプ: application/json ✓

すべてのリクエストで、アクセス キーを Content-Type: application/json のトークン ヘッダーとして送信します。

02 · 送信POST /外部/SMS{ msgstr: "9f2a7c10"、エラーコード: 0 }

from、to、コンテンツを POST します。応答はすぐに msgid とエラーコードとともに返されます。

03 · 追跡GET /report?status=Delibrd200 OK

メッセージが最終状態に達した瞬間に、コールバック URL にステータス レポートを POST または GET します。

送信

すでに使用している言語でリクエストを 1 つ

送信者、受信者、コンテンツをトークン ヘッダーを付けて POST します。受け入れた瞬間に返事が返ってきます。

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · 承認されました

msgstr 「9f2a7c10-4b2e-…」

方向 「山」

エラーコード 0

を保存します。 msgstr — ここからこのメッセージを追跡する方法です。

メッセージオブジェクト

メッセージを上から下まで読んでください

送信、ステータス、および受信イベントはすべて同じ形状を返します。一度学習してください。

01メッセージID

メッセージID

msgid — メッセージが作成された瞬間に作成されます。これは、後でステータスを確認するために使用するハンドルです。

02送信者

送信者

from — 電話番号、または最大 11 文字の英数字 ID、受信者に表示される ID。

03受信者

受信者

to — メッセージの宛先番号 (国コードを含む)。

04エンコーディング

エンコーディング

データコーディング — GSM7 は 1 パートあたり 160 文字に適合します。 Unicode に切り替えると、70 に下がります。さらに進むと、追加の請求部分に連結されます。

05方向

方向

方向 — すべてのメッセージは mt (送信者) または mo (受信者) であり、どちらの形式でも同じです。

06エラーコード

エラーコード

エラーコード — 送信応答およびすべてのステータス レポートで返されます。 0 は受け入れられたことを意味します。それ以外のものは、何が問題だったのかを正確に示します。

参照

1 つのエンドポイント、2 つの動詞

送信するには POST、ステータスを確認するには GET — どちらの方法でも同じ URL と同じトークン ヘッダーです。

役職

送信

メッセージを送信すると、すぐに msgid とエラーコードが返されます。

返品 msgstr + エラーコード
得る

追跡

すでに送信したメッセージを検索して現在のステータスを確認します。

返品 メッセージ + ステータス
Webhook

ステータスレポート、発生した瞬間

コールバック URL を設定すると、すべての配信、失敗、受信応答が GET または POST としてそこに到達します。ポーリングは必要ありません。

配達されましたmsgstr 9f2a7c10 · ステータス
インバウンド返信頂きました・方向も
失敗したmsgstr 4c81e2 · ステータス失敗
あなたのエンドポイント200 OK
始めましょう

API キーを取得する

REST API を使用すると、数分で統合を開始できます。

あなたの質問への答え

開発者向けドキュメント — よくある質問

すべてのリクエストのトークン ヘッダーでアクセス キーを渡します (トークン: {accessKey})。Content-Type: application/json とともに渡します。

送信するたびに msgid が返されます。コールバック URL を指定すると、メッセージが最終状態 (subdate、doneddate、およびその結果のステータス コードを含む) に達した瞬間にステータス レポートを POST または GET します。

mt (モバイル終了) はあなたが送信したメッセージです。 mo(モバイル発信)はあなたが受け取った返信です。どちらも同じメッセージ オブジェクトの形状を使用します。

配信は再試行ポリシーに従って再試行されます。何も通知せずにドロップされることはありませんが、決して応答しないエンドポイントは再試行を受信し続けます。

GSM7 エンコードでは 160 文字、Unicode では 70 文字。制限を超えると、メッセージは複数の部分に連結され、それぞれが個別に請求されます。