← API リファレンス
メッセージPOST

テキストメッセージ送信

指定したプロバイダアカウントから正規化されたテキストメッセージを送信します。provider_data に reply_to や parse_mode などプロバイダ固有のフィールドを含められます。

https://api.unifyport.ai/v1/messages

ヘッダー

X-Api-Key
string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

Content-Type
string必須

JSON のリクエストボディを送る場合は application/json を使用します。

パスパラメータ

このエンドポイントにパスパラメータはありません。

リクエストボディ

account_id
string必須

メッセージを送信するプロバイダアカウント。

to
object必須

宛先（id と type）。

message
object必須

正規化されたメッセージペイロード。テキストは message.text、メディアは message.url を使用します。

provider_data
object

reply_to や parse_mode のようなプロバイダ固有オプション。

レスポンスボディ

message_id
string

受理されたメッセージの UnifyPort メッセージ識別子（msg_...）。

account_id
string

このレスポンスが対象とするプロバイダアカウント。

status
string

受理ステータス。accepted はメッセージがプロバイダへの配信待ちにキューイングされたことを意味します。

provider_ref
string

プロバイダが割り当てたあとの、プロバイダ側メッセージ参照。

レスポンス

200
200 OK

リクエスト成功。レスポンスボディの例を参照してください。

400
Bad Request

リクエストボディ、パス、またはパラメータが不正です。

401
Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

409
Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500
Internal Server Error

サービスで予期しないエラーが発生しました。

リクエスト

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": "text",
    "text": "Hello from UnifyPort"
  },
  "provider_data": {
    "parse_mode": "markdown"
  }
}'

レスポンス

{
  "data": {
    "message_id": "msg_example",
    "account_id": "acc_example",
    "status": "accepted",
    "provider_ref": "provider_msg_example"
  }
}