更新卡片消息
更新时间:2025-01-23 12:57:58

更新卡片消息

请求方法

PUT

请求地址

/messages

请求参数

参数 参数类型 数据类型 是否必需 描述
msgId Body Long 更新的消息id
sessionId Body Long 消息对应的会话id 【群聊会话需要带上】
updateAll Body Boolean 更新卡片消息时群聊会话支持更新全部成员的卡片,为true时无需指定targetIds
body Body String 消息内容 【限制:消息请求体最大不能超过64KB】
targetIds Body List 指定需要更新的用户id 【限制:数量上限2000】

HTTP状态码

返回值 描述
200 操作成功,详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

请求消息示例

PUT /open/api/v2/messages HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
    "msgId": 123,
    "sessionId": 321,
    "body": "...(内容需要遵循卡片消息格式)",
    "targetIds": [
        "8d07a56207074d26b61026099625b9e2"
    ]
}

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

CURL命令示例

curl -XPUT -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H "Content-type: application/json" -d '{"msgId": 123,"sessionId":321,"body": "hello","targetIds": ["8d07a56207074d26b61026099625b9e2"]}' 'https://api.yealink.com/open/api/v2/messages'
本页目录