文档中心.统一通行证

APP 消息推送

接口说明

目前 APP 消息推送接口的调用与其他开放接口有所差异，消息推送的接口鉴权需要通过调用方自行生成签名参数。签名的算法细节可查看附录

基本信息

请求方式： POST

请求地址：https://sso-center.myyscm.com/v1/message/single-push

请求参数

参数名	参数位置	参数类型	是否必填	默认值	描述
apiCode	Body	String	是		接口调用方标识，用于获取 apiKey 进行参数签名验证
tenantCode	Body	String	是		云链租户号
appid	Body	String	是		星图应用 AppKey。如果字段值传空字符串，则通过 unionid 和 tenantCode 两个参数获取用户设备信息进行消息推送，这种推送方式可能无法确保接受消息的是哪个 APP。如需精确推送推荐使用 appid
unionid	Body	String	是		用户在云链的唯一身份标识。如果没有该数据，也可以传入用户手机号
msgType	Body	String	是		消息类型：1-通知消息、0-透传消息。默认为 1
title	Body	String	是		Andorid 消息推送标题
content	Body	String	是		推送的消息内容
custom	Body	Object	否		自定义消息内容，只有当 msgType=0 为透传消息内容时有效。当接收消息的是云链超级 APP 时，需要与云链相关开发确认对应的数据格式，用于业务自定义扩展。透传消息格式的参数必须是 appCode 和 params，appCode 为统一登录凭证使用的 appCode，params 为自定义参数，需要 APP 基座支持
nonce	Body	String	是		用于生成签名的随机字符串，调用方自行生成，建议不超过 32 个字符长度
timestamp	Body	Number	是		用于签名的时间戳，单位：秒
signature	Body	String	是		参数签名。参与签名的参数有：appid、unionid、apiKey、nonce、timestamp

请求示例

POST
https://sso-center.myyscm.com/v1/message/single-push
{
  "apiCode": "ggcp",
  "tenantCode": "testtest",
  "appid": "OldWEGPkPCODD6A4DgmpwvHd8KEt3EIa",
  "unionid": "395779830505ca009ea8537d1429fada74ac",
  "msgType": 1,
  "title": "消息标题",
  "content": "您有一个 xxx 项目的移动审批待处理",
  "custom": {
    "appCode": "gcxt",
    "params": {
      "title": "自定义消息标题",
      "proj_id": 123,
      "module": "check"
    }
  },
  "nonce": "zxckljvbiu24b1542",
  "timestamp": 1500000000,
  "signature": "5ae62aad2c0916747b2214f1853d907cbf7feff3"
}

成功返回示例

{
  "errcode": 0,
  "message": "Success"
}

成功返回参数说明

参数名	参数类型	描述
Errcode	Number	业务错误码，0 正常，非 0 均为发生业务错误
Message	String	接口响应数据业务说明，调用失败时为相应的错误说明

失败返回示例

{
  "errcode": 10001,
  "message": "Failure message."
}

失败返回参数说明

参数名	参数类型	描述
errcode	Number	业务错误码，0 正常，非 0 均为发生业务错误
message	String	接口响应数据业务说明，调用失败时为相应的错误说明

results matching ""

No results matching ""