← API 参考
消息POST

发送文本消息

通过指定的渠道账号发送一条标准化的文本消息。provider_data 可承载 reply_to、parse_mode 等渠道专属字段。

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

请求头

X-Api-Key
string必填

工作区 API Key，工作区由该请求头解析得到。

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
请求错误

请求体、路径或参数不合法。

401
未授权

X-Api-Key 请求头缺失或无效。

409
冲突

当前操作与已有的渠道账号或资源冲突。

500
服务端错误

服务端遇到了未预期的错误。

请求

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"
  }
}