BSS-OpenAPI

短信/邮件发送

POST

/notice/send

crm-app-notice/发送

接口变更记录

变更版本	变更时间	变更人	变更内容	备注
V1.0.0	2023-08-22	lemon	出入参下划线转驼峰

错误码

code	msg	msg_cn

请求结构

1.

通信协议: Http、Https

2.

字符编码: UTF-8

公共参数

https://apifox.com/apidoc/shared-5e679ecb-cbd8-4b2c-bbcb-ab16232fb608/doc-2903487

签名方法

1.

暂无

公共返回结果

https://apifox.com/apidoc/shared-5e679ecb-cbd8-4b2c-bbcb-ab16232fb608/doc-2903489

错误码

错误码	描述	message
850000	无供应商配置	No vendor configuration.
850001	邮件发送失败	Mail sending failed.
850002	短信发送失败	SMS sending failed.
850004	获取邮件地址失败	Failed to obtain email address.
850005	电子邮件格式不正确	Incorrect email format.
850006	公共服务内部错误	Notice center Service Internal Error.
850007	公共服务超时	Notice center service timeout.
850008	公共服务未响应	Notice center Service not responding.
850009	公共服务网络异常	Notice center Service network exception.
850010	发送mq异常	Push mq failed.
850011	通知类型无法匹配	The notification type does not match.
850012	触发角色不正确	Trigger Role not allow.
850013	内部业务流程异常	sendNotice failed.
850014	没有可发送的通知对象	There are no notification objects to send.
850015	缺少必传参	Missing MustParameter.
850016	知正常发送中，请刷新页面查看最新状态	The notification is being sent normally, please refresh the page to check the latest status.

1.

用于发送通知

接口压测

实际并发数	实际RT	实际TPS	频率限制次数（次/秒）
25.00	5277.89	4.63	无

请求参数

Body 参数application/json

type

string

必需

发送类型, 短信sms 邮件email

targetUuid

string

操作对象的uuid

必需

operatorUuid

string

必需

操作者本人的uuid

eventKey

string

事件key

必需

mustParameter

object

必需

事件key对应变量参数

type

string

必需

短信sms 邮件email

email

string

可选

邮箱 type =email必填

phone

string

可选

手机号 type =sms必填

area_code

string

可选

手机区号 type =sms必填

code

string

验证码

可选

lang

string

语言

可选

uuid

string

可选

示例

{
  "targetUuid": "65",
  "operatorUuid": "12",
  "status": "success",
  "eventKey": "verification_code",
  "mustParameter": {
    "type": "sms",
    "email": "j.ksd@qq.com",
    "phone": "13516862479",
    "area_code": "651245",
    "code": "11",
    "lang": "labore tempor ullamco",
    "replace_email": "e.tely@qq.com",
    "is_reception_email": true,
    "uuid": "65"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/notice/send' \
--header 'Content-Type: application/json' \
--data-raw '{

    "targetUuid": "65",
    "operatorUuid": "12",
    "status": "success",
    "eventKey": "verification_code",
    "mustParameter": {
        "type": "sms",
        "email": "j.ksd@qq.com",
        "phone": "13516862479",
        "area_code": "651245",
        "code": "11",
        "lang": "labore tempor ullamco",
        "replace_email": "e.tely@qq.com",
        "is_reception_email": true,
        "uuid": "65"
    }
}'

返回响应

🟢200OK

application/json

Body

code

integer <int32>

可选

data

null

可选

msg

string

可选

success

boolean

可选

分页查询零售客户配置

文件上传（图片相关）