Message Push API

Message Push APIはチャットユーザーにメッセージをプッシュするAPIです。 一部プラットフォームでのみ利用できます。

  • Endpoint: https://api.obotai.com/chat/message/push

  • Method: POST

利用可能なプラットフォーム

  • LINE

  • WebChat

  • Slack

  • WebChatV2

  • Facebook

リクエスト

Body

{
    "session_id": "user-session-id",
    "response_id": "response-id",
    "platform": "user-chat-platform",
    "contents": []
}
フィールド 要否 タイプ
session_id 必須 String
response_id オプション String
platform 必須 String
contents 必須 List

Platform Value

  • web_chat

  • line

  • slack

  • web_chat_v2

  • facebook

Contents Value

  • Text

{
    "type": "text",
    "text": "Hello World!"
}

  • Image

{
    "type": "image",
    "url": "https://example.com/example.jpg"
}

  • Payload

# 各チャットプラットフォームのドキュメントを参照
{
    "type": "payload",
    "payload": {}
}

レスポンス

{
    "status": 200,
    "message": "response message"
}

利用例

curl:

curl -X POST \
  https://api.obotai.com/chat/message/push \
  -H 'X-Api-Key: 00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{
    "session_id": "user-session-id",
    "response_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-xxxxxxxx",
    "platform": "line",
    "contents": [
        {
            "type": "text",
            "text": "Hello World!"
        }
    ]
}'

Python:

import requests
import json

url = "https://api.obotai.com/chat/message/push"

data = {
    "session_id": "user-session-id",
    "response_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-xxxxxxxx",
    "platform": "line",
    "contents": [
        {
            "type": "text",
            "text": "Hello World!"
        }
    ]
}

headers = {
    'X-Api-Key': "00000000-0000-0000-0000-000000000000",
    'Content-Type': "application/json",
    }

response = requests.request("POST", url, data=json.dumps(data), headers=headers)

print(response.text)