通知を送信
このインターフェースは、外部システムからの通知プッシュに使用されます。
リクエストメソッド
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"
}
}'