API連携ガイド
CRM、予約システム、またはあらゆるアプリケーションを接続し、当社のシンプルなAPIを通じてWhatsAppメッセージを送信できます。
5つの簡単なステップで始める
デスクトップアプリをダウンロード
Windowsコンピューターに All-in-One Messenger Hub をダウンロードしてインストールします。
WhatsAppを接続
QRコードをスキャンして、アプリにWhatsAppアカウントを追加します。
Session APIを作成
WhatsAppタブに移動し、新しいSession APIを作成します。WhatsAppチャンネルにリンクします。
APIキーをコピー
生成されたAPIキーをコピーします。認証情報なので、安全に保管してください。
メッセージの送信を開始
アプリケーションからAPIを使用します。メッセージを配信するために、デスクトップアプリを起動したままにしてください。
認証
すべてのAPIエンドポイントは、APIキーによる認証が必要です。キーは以下のいずれかの方法で渡せます:
| 方法 | 例 |
|---|---|
| X-API-Keyヘッダー(推奨) | X-API-Key: your-api-key |
| クエリ/ボディパラメーター | key=your-api-key |
| 代替パラメーター | api_key=your-api-key |
メッセージを送信
電話番号またはグループにWhatsAppメッセージを送信します。メッセージはキューに入れられ、デスクトップアプリの起動時に配信されます。
POST https://onemessengerhub.com/api/whatsapp-session/send
パラメーター
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
key |
string | はい | デスクトップアプリで取得したAPIキー |
mobile |
string | 条件付き | 国番号付きの電話番号(group_idがない場合は必須) |
group_id |
string | 条件付き | WhatsAppグループID(mobileがない場合は必須)。@g.usの接尾辞は自動で追加されます。 |
message |
string | はい | メッセージのテキスト(最大4096文字) |
リクエスト例
curl -X POST https://onemessengerhub.com/api/whatsapp-session/send \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"mobile": "1234567890", "message": "Hello!"}'
シンプルなGETリクエスト(ブラウザまたはリンク)
https://onemessengerhub.com/api/whatsapp-session/send?key=YOUR_API_KEY&mobile=1234567890&message=Hello!
成功時のレスポンス(201)
{
"success": true,
"message": "Message queued successfully",
"data": {
"message_id": 123,
"recipient": "1234567890",
"status": "pending"
}
}
連絡先を保存
WhatsAppに連絡先を保存または名前を変更します。操作はキューに入れられ、デスクトップアプリが処理します。
POST https://onemessengerhub.com/api/whatsapp-session/save-contact
パラメーター
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
key |
string | はい | デスクトップアプリで取得したAPIキー |
contact_id |
string | はい | 連絡先の電話番号またはWhatsApp ID(最大50文字)。@c.usの接尾辞は自動で追加されます。 |
name |
string | はい | 連絡先の表示名(最大255文字) |
リクエスト例
curl -X POST https://onemessengerhub.com/api/whatsapp-session/save-contact \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"contact_id": "1234567890", "name": "John Doe"}'
成功時のレスポンス(201)
{
"success": true,
"message": "Contact save operation queued",
"data": {
"operation_id": 456,
"contact_id": "[email protected]",
"status": "pending"
}
}
連絡先を削除
WhatsAppから連絡先を削除します。操作はキューに入れられ、デスクトップアプリが処理します。
POST https://onemessengerhub.com/api/whatsapp-session/remove-contact
パラメーター
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
key |
string | はい | デスクトップアプリで取得したAPIキー |
contact_id |
string | はい | 連絡先の電話番号またはWhatsApp ID(最大50文字)。@c.usの接尾辞は自動で追加されます。 |
リクエスト例
curl -X POST https://onemessengerhub.com/api/whatsapp-session/remove-contact \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"contact_id": "1234567890"}'
成功時のレスポンス(201)
{
"success": true,
"message": "Contact remove operation queued",
"data": {
"operation_id": 789,
"contact_id": "[email protected]",
"status": "pending"
}
}
エラー処理
APIは標準のHTTPステータスコードを使用します。一般的なエラーレスポンスは以下のとおりです:
認証エラー(401)
{
"success": false,
"message": "Invalid or inactive API key"
}
バリデーションエラー(422)
{
"success": false,
"message": "Validation failed",
"errors": {
"mobile": ["The mobile field is required when group id is not present."],
"message": ["The message field is required."]
}
}
構築できるもの
CRM連携
フォローアップメッセージ、リマインダー、更新をCRMシステムから直接送信します。
予約の確認
予約の確認とリマインダーを顧客に自動で送信します。
注文通知
注文状況、配送の更新、配達情報を顧客に通知します。
アラートシステム
重要なアラートと通知をチームや顧客に送信します。
マーケティングキャンペーン
プロモーションメッセージと更新を連絡先リストに送信します。
カスタムワークフロー
Zapier、Make、n8n、またはあらゆる自動化プラットフォームと連携します。
さらに多くのAPIが近日公開
より多くのプラットフォームとユースケースをカバーするため、API提供を拡大しています。
チャットボットAPI
チャットボットの応答をトリガーし、会話をプログラムで管理します。
連絡先API
プラットフォームをまたいでメッセンジャーの連絡先にアクセスし管理します。
Webhook
メッセージの受信時または送信時にリアルタイムの通知を受け取ります。
All-in-One Messenger Hub