API リファレンス

はじめに

画像とファイルを送信

チャネルの対応状況を確認し、アクセス可能なメディア URL と対応する形式を使います。

はじめる

  1. 1

    呼び出す前に

    チャネルの対応状況を確認し、アクセス可能なメディア URL と対応する形式を使います。

    統一メッセージ送信の対応状況
  2. 2

    パラメーターの取得元

    返信時は message.received の data.conversation.id と data.conversation.type を to.id と to.type にコピーします。新規宛先はチャネルの識別子規則に従います。

    テキストメッセージ送信
  3. 3

    メディアメッセージ送信

    チャネルの対応状況を確認し、アクセス可能なメディア URL と対応する形式を使います。

    curl -X POST "https://api.unifyport.ai/v1/messages" \
      -H "X-Api-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{
      "account_id": "acc_example",
      "to": {
        "id": "user_example",
        "type": "user"
      },
      "message": {
        "type": "video",
        "url": "https://cdn.example.com/video/demo.mp4",
        "caption": "hello video"
      },
      "provider_data": {
        "seconds": 12
      }
    }'
    メディアメッセージ送信
  4. 4

    結果の確認

    後続イベントとの照合や調査のため message_id と provider_ref を保存します。accepted は配達完了を意味しません。チャネルが対応する場合にのみ、受領イベントで配達を確認してください。識別子の形式はチャネルにより異なります。

    Webhook delivery & signature verification