云通訊平臺為開發者提供了服務器推送接口,即從服務器端向客戶端推送消息,可用于推送系統通知等使用場景。
1、請求地址
/{SoftVersion}/Application/{appId}/IM/PushMsg
2、請求包頭
請參閱《鑒權說明》
3、請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
pushType | int | 必選 | 推送類型,1:個人,2:群組,默認為1 |
sender | String | 必選 | 發送者帳號,必須在客戶端登錄過,且sender所在客戶端的appid要與請求的appid要統一,長度不得超過96個字符 |
senderNickName | String | 可選 | 發送者昵稱 |
receiver | String | 必選 | 接收者帳號,如果是個人,最大上限100人/次,如果是群組,僅支持1個;如果需要跨應用給個人發送信息,需要在接收者帳號前加appid和#。例如:appid=1,接收者帳號=a,則需要拼為1#a。由于群組ID為唯一ID,因此跨應用給群組發送消息無需增加appid和#。 |
msgType | int | 必選 | 消息類型,1:文本消息,2:語音消息,3:視頻消息,4:圖片消息,5:位置消息,6:文件,26:指令消息 |
msgContent | String | 可選 | 文本內容,最大長度2048字節,文本和附件二選一,不能都為空 |
msgDomain | String | 可選 | 擴展字段,最大長度2048字符 |
msgFileName | String |
可選 | 文件名,最大長度128字節 |
msgFileUrl | String | 可選 | 文件絕對路徑,最大長度1024個字符。 |
extOpts
此參數需要進行base64加密 |
String | 可選 | "isSave":"", msgType=26時,是否保存,1:保存,非1:不保存 |
String | 可選 | "isOfflinePush":"", msgType=26時,是否走離線推送,1:離線推送,2:不走離線推送,3:不走離線推送,并返回發送者錯誤碼 | |
String | 可選 | "isHint":"", msgType=26時,是否提示 1:提示,非1:靜默通知 | |
String | 可選 | "isSyncMsg":"", msgType=26時,消息是否同步多設備,1:同步,2:不同步 | |
String | 可選 | "apsalert":"", 自定義消息推送內容 |
4、請求示例
POST /2013-12-26/Application/297e7c37446272f301/IM/PushMsg?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "pushType":"1", "sender":"13291217102", "receiver":["18201370642","13121353225"], "msgType":"1", "msgContent":"你好", "msgDomain":"yuntongxun", "msgFileName":"", "msgFileUrl":"", "extOpts":"" }
5、響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功) |
statusMsg | String | 必選 | 取值success(成功) |
msgId | String | 必選 | 消息Id |
timestamp | String | 必選 | 時間戳 |
6、響應示例
HTTP/1.1 200 OK Content-Length:586 {"statusCode":"000000","statusMsg":"success","msgId":"","timestamp":""}
文檔更新時間:2018年1月18日