跳至主要内容

创建会话

创建一个会话。

请求

POST https://apichat.twt.com/openapi/chat/create_gd

Header 参数

参数名类型必填说明
x-chat-signaturestringHMAC-SHA256 签名。使用实际发送的原始 JSON body 计算 hash_hmac('sha256', raw_body, app_secret)
Acceptstring默认:application/json
Content-Typestringapplication/json

Body 参数

参数类型必填说明
appidstring控制台中的应用标识
timestampinteger请求时间戳,生产环境中过期时间戳可能被拒绝
ranstrstring随机字符串
sbsstring客户唯一标识,1 到 64 个字符。客户不存在时自动创建
ipstring客户 IP 地址
sbs_mcstring客户姓名,1 到 30 个字符
contentstring初始消息,1 到 2000 个字符。该消息以负责人客服身份发送
titlestring会话标题,1 到 120 个字符。传入后作为访客和客服备注标题
kefu_idarray[integer]客服 ID 列表,允许多个客服
fzr_uidinteger负责人客服 ID,必须包含在 kefu_id

请求示例

curl --location --request POST 'https://apichat.twt.com/openapi/chat/create_gd' \
--header 'x-chat-signature: 0bf19198ab2dd65a407ca8d57fbb3f6ebca71d22709a1f5d53c685e9e25abdbc' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"appid": "42d7c13c16e7ed0479f2418eb8894310",
"timestamp": 1781683144,
"ranstr": "codex1033048655",
"sbs": "customer_001",
"kefu_id": [
10411,
10427
],
"fzr_uid": 10411,
"ip": "127.0.0.1",
"sbs_mc": "客户姓名",
"content": "初始消息",
"title": "订单咨询"
}'

返回响应

200 成功

参数类型必填说明
codeinteger1 成功,-1 失败
msgstring响应提示
data.chat_idinteger创建成功的会话 ID
{
"code": 1,
"msg": "ok",
"data": {
"chat_id": 900220
}
}

失败示例

{
"code": -1,
"msg": "token验证失败!",
"data": ""
}
{
"code": -1,
"msg": "参数错误",
"data": ""
}

注意事项

  • content 必填,并以 fzr_uid 对应负责人客服身份发送。
  • title 非必填,传入后保存为访客和客服备注标题,自动总结标题仍按正常逻辑生成。
  • fzr_uid 必须属于 kefu_id 集合。
  • fzr_uid 外的客服会作为会话参与人加入。
  • 签名必须基于实际发送的原始 JSON body 计算,字段顺序、空格和换行都需要保持一致。