发送通知
该接口用于外部系统通知推送接口
请求方法
post /agent_notices
请求参数(Request String)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
agent_notice | 对象 | 是 | 通知对象 |
通知对象
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
content | 字符串 | 是 | 通知内容 |
targets | 字符串数组 | 是 | 通知目标标识(target_find_method使用的ID, 邮件, 工号) |
target_type | 字符串 | 是 | 通知目标类别(user: 坐席, group: 坐席组) |
target_find_method | 字符串 | 是 | 通知目标查找方法 坐席支持 by_id: 按ID, by_work_id: 按工号, by_email: 按邮件; 坐席组支持 by_id: 按坐席组ID |
external_source | 字符串 | 否 | 渠道名称, 默认为 管理员 |
返回数据
属性名 | 类型 | 说明 |
---|---|---|
code | 整型 | 执行结果码, 1000代表成功 |
message | 字符串 | 执行结果说明 |
id | 整型 | 通知ID |
示例
curl --location -g --request POST 'https://{{subdomain}}.udesk.cn/open_api_v1/agent_notices?email={{email}}&sign_version=v2&nonce={{nonce}}×tamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"agent_notice": {
"target_type": "user",
"target_find_method": "by_id",
"targets": [1],
"content": "OpenApi测试",
"external_source": "OpenApi"
}
}'