Appearance
createDing 发钉
接口说明
发钉
使用说明
是否需要鉴权 | ** 是否支持Android** | ** 是否支持IOS** | ** 是否支持PC** |
---|---|---|---|
是 | 是 | 是 | 否 |
参数说明
名称 | ** 类型** | ** 是否必填** | ** 示例值** | ** 描述** |
---|---|---|---|---|
users | Array | 是 | 需要发钉的用户ID | |
corpId | String | 否 | 租户ID | |
alertType | Number | 是 | 发钉类型;1表示短信发钉(saas环境默认没开),2表示应用内发钉。 | |
text | String | 是 | 发钉内容 |
返回参数
名称 | ** 类型** | ** 示例值** | ** 描述** |
---|---|---|---|
success | Boolean | 是否发送成功 |
用法示例
javascript
SZHN_HZT_SDK.createDing({
users: ["1234"],
alertType: 2,
text: "ding"
}).then(rest => {
console.log(rest)
}).catch(err => {})
补充说明
错误信息:
- 发钉成功:返回 {“success”: true}
- 租户Id错误: {errorCode: 2,errorMag:corpId error} ;租户id非必填,填了就判断租户id正确性
- 钉内容text为空或为null:{errorCode: 2,errorMag:text can"t be empty}
- 钉内容text包含敏感词:{errorCode: 2,errorMag:text can"t contain sensitive words}
- 发钉 usersId 包含 自己 :{errorCode: 2,errorMag:users can‘t include oneself}
- 发钉 usersId 为空 :{errorCode: 2,errorMag:users can"t be empty}
- 发钉 usersId 错误 :{errorCode: 2,errorMag:send failed}
- 发钉 usersId 部分错误 :{errorCode: 2,errorMag:partial send failed}