消息

向最终用户发送合作伙伴中心消息。

发送消息

POST /api/v1/messages

创建一条独立中心消息,而不是支持对话。

请求头

Authorization: Bearer <api_key>
Content-Type: application/json

正文参数

字段类型必填说明
phonestringE.164 目标号码
bodystring*文本正文 / 说明文字(text 类型必填)
content_typestring默认为 text。请参阅媒体类型
template_codestring使用 vars 渲染
varsobject模板变量
prioritystringotp · notification · chat
idempotency_keystring对重试去重
media_urlstring*媒体类型的远程文件 URL
media_base64string*使用 Base64 文件代替 URL
media_filenamestring显示名称
media_mimetypestringMIME 类型
link_url / urlstring*用于 content_type=link
link_label / ctastring按钮标签
link_titlestring卡片标题
link_descriptionstring卡片说明
link_image_urlstring卡片图片
htmlstring*用于 content_type=html
subjectstring新闻简报标题(HTML)
previewstring纯文本预览(HTML)

文本示例

curl -X POST "$API/messages" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+228XXXXXXXX",
    "body": "Votre dossier est en cours de traitement.",
    "priority": "notification",
    "idempotency_key": "seed-dossier-1001"
  }'

201 响应

{
  "message_id": 142,
  "ref": "52c22ee01478…",
  "phone": "+228XXXXXXXX",
  "partner": "seed",
  "direction": "out",
  "content_type": "text",
  "body": "Votre dossier est en cours de traitement.",
  "state": "delivered",
  "priority": "notification",
  "created_at": "2026-07-21 07:10:00"
}

获取消息

GET /api/v1/messages/{message_id}

返回消息及可选的投递尝试。

列出消息

GET /api/v1/messages

查询参数说明
phone按账户手机号码筛选
statequeued · delivered · read
q搜索正文 / 联系人
limit页面大小

标记已读 / 未读(合作伙伴工具)

POST /api/v1/messages/{id}/read
POST /api/v1/messages/{id}/unread
POST /api/v1/messages/read

客服人员聊天发送

POST /api/v1/agent/messages

供合作伙伴中心的客服人员使用。适当时,它可以附加到未关闭的支持对话。自动化中心通知应优先使用 /messages