消息推送

请求参数

Authorization

Query 参数

access_token

string

必需

Header 参数

User-Agent

string

可选

默认值:

CX

Body 参数application/json

type

enum<string>

消息推送类型

可选

消息推送类型，MOBILE或者ACCOUNT。不传的话默认为MOBILE类型, MOBILE：按照手机号推送。 ACCOUNT：按照账号id推送。

枚举值:

USERMOBILEACCOUNT

默认值:

AacEnums.PushType.MOBILE

recipients

array[string]

消息目标

必需

接收消息的用户id或手机号，推荐长度为200个一组, 超过1000有可能会被服务器拒绝当type为ACCOUNT时，这里传递用户在橙讯中的account_id（通过单点登录的验证授权Code接口或者通讯录同步能获取用户的account_id）当type为MOBILE时，这里传递用户在橙讯中的手机号（带国家编号，比如+8613900001111）。

<= 200 items

payload

string

给native app推送的数据

可选

给native app推送的数据，数据最终转发给对接应用的客户端，由该客户端自己解析。 1. 消息中如果包含 native_payload，且应用为当前平台已上架原生应用，则将消息透传至对应的原生应用； 2. 其他情况则忽略 native_payload，处理 badge_number，message。

badge_number

integer

角标数量

可选

显示在工作台应用图标上的badge数。

message

string

显示内容

可选

message 对象字符串，显示在橙讯客户端的消息中心： { "msgType":"", //有效值为：text、link、multi_link "msgContent": "" //msgContent对象字符串，msgContent对象参考后面定义 }

示例

{
    "badge_number": "3",
    "recipients": [
        "+8615510849345"
    ],
    "type": "MOBILE",
    "message": "{\"msgType\":\"link\",\"msgContent\":\"{\\\"subject\\\":\\\"出差申请单\\\",\\\"actions\\\":[{\\\"name\\\":\\\"部门主管审批\\\",\\\"action\\\":\\\"https://chc.chu.com\\\"}],\\\"content\\\":\\\"赴北京出差申请预计2200.00元\\\"}\"}"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://service.cheng-xun.cn/api/apps/v1/push?access_token' \
--header 'User-Agent: CX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "badge_number": "3",
    "recipients": [
        "+8615510849345"
    ],
    "type": "MOBILE",
    "message": "{\"msgType\":\"link\",\"msgContent\":\"{\\\"subject\\\":\\\"出差申请单\\\",\\\"actions\\\":[{\\\"name\\\":\\\"部门主管审批\\\",\\\"action\\\":\\\"https://chc.chu.com\\\"}],\\\"content\\\":\\\"赴北京出差申请预计2200.00元\\\"}\"}"
}'

返回响应

🟢200成功

application/json

Body

Created by yangm on 10/24/19.

err_code

integer

可选

err_msg

string

可选

默认值:

ErrorCode.SUCCESS.getErrMsg()

示例

{
    "err_code": 0,
    "err_msg": ""
}

请求地址：https://service.cheng-xun.cn/api/apps/v1/push?access_token={access_token}
请求方式：POST
请求Body：
{
"type": "MOBILE",
"recipients": ["+8613800001111", "+8613800001112"],
"payload": "String",
"badge_number": 1,
"message": "String"
}

WARNING：`payload`、`badge_number`、`message`原则上是不允许同时发送的。

请求参数

示例代码

返回响应

消息推送

请求地址：https://service.cheng-xun.cn/api/apps/v1/push?access_token={access_token} 请求方式：POST请求Body： {"type": "MOBILE","recipients": ["+8613800001111", "+8613800001112"], "payload": "String", "badge_number": 1,"message": "String" }#

WARNING：payload、badge_number、message原则上是不允许同时发送的。#

请求参数

示例代码

返回响应

请求地址：https://service.cheng-xun.cn/api/apps/v1/push?access_token={access_token}
请求方式：POST
请求Body：
{
"type": "MOBILE",
"recipients": ["+8613800001111", "+8613800001112"],
"payload": "String",
"badge_number": 1,
"message": "String"
}

WARNING：`payload`、`badge_number`、`message`原则上是不允许同时发送的。