閱讀292 返回首頁    go 魔獸


Message操作__主題接口規範_API使用手冊_消息服務-阿裏雲

描述

該接口用於發布者向指定的主題發布消息,消息發布到主題後隨即會被推送給 Endpoint 消費。

Request

Request 的構造主要由以下幾個部分組成:

  • 請求行

    POST /topics/$TopicName/messages HTTP/1.1

  • 特有 Request Header

    無,請參考 調用方式/公共參數

  • Request Body

    Request Body 為 XML 格式

參數名稱 說明 參數值 選項
MessageBody 消息正文 字符集 Required
MessageTag 消息標簽(用於消息過濾) 不超過16個字符的字符串(默認沒有標簽) Optional
MessageAttributes 消息屬性,如果需要推送到郵件終端,則MessageAttributes為必填項 字符集 Optional

如果需要推送到MailEndpoint,MessageAttributes需要包含DirectMail屬性。
DirectMail屬性的Text內容是Json格式,需要包含以下字段
(字段含義可以參考https://help.aliyun.com/document_detail/29444.html ):

  1. AccountName (必選,發信賬號,string)
  2. Subject (必選,郵件主題,string)
  3. AddressType (必選,0或1)
  4. IsHtml(必選,郵件內容是否作為Html處理,0或1)
  5. ReplyToAddress(必選,0或1)

Response

返回消息有返回狀態行、HTTP頭和消息體三部分組成

  • HTTP Status Code

    HTTP/1.1 201 Created

  • 特有 Response Header

    無,請參考 調用方式/公共參數

  • Response Body

    返回的結果為 XML 格式,包括 MessageId 和 MessageBodyMD5:

參數名稱 說明
MessageId 消息編號,在主題中唯一
MessageBodyMD5 消息正文的 MD5 值

Special Error

錯誤代碼 錯誤信息 狀態碼
TopicNotExist The topic you provided does not exist. 404

請求示例:

  1. POST /topics/$TopicName/messages HTTP/1.1
  2. Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
  3. Date: Tue, 08 Dec 2015 06:13:40 GMT
  4. Content-Length:500
  5. Content-Type:text/xml;charset=utf-8
  6. Authorization: MNS 15B4D3461F177624206A:aibzWu1iDEx9LwO56+kHgA3eqmI=
  7. x-mns-version: 2015-06-06
  8. <?xml version="1.0" encoding="utf-8"?>
  9. <Message xmlns="https://mns.aliyuncs.com/doc/v1/">
  10. <MessageBody>Base64 Encoded Result</MessageBody>
  11. <MessageTag>important</MessageTag>
  12. <MessageAttributes>
  13. <DirectMail>{"Subject":"TestMailSubject","AccountName":"direct_mail_account_name@aliyun-inc.com","ReplyToAddress":0,"AddressType":0,"IsHtml":0}</DirectMail>
  14. </MessageAttributes>
  15. </Message>

返回示例:

  1. HTTP/1.1 201 Created
  2. Content-Length:120
  3. Content-Type:text/xml;charset=utf-8
  4. x-mns-request-id:56667514B2B71C9C1600002B
  5. x-mns-version:2015-06-06
  6. <?xml version="1.0" encoding="utf-8"?>
  7. <Message xmlns="https://mns.aliyuncs.com/doc/v1/">
  8. <MessageId>D273CD6A89564E54-1-15180395A19-200000001</MessageId>
  9. <MessageBodyMD5>3AC6DD36D2D6B7283F2F490A09751BFE</MessageBodyMD5>
  10. </Message>

最後更新:2016-11-23 17:16:04

  上一篇:go Subscription操作__主題接口規範_API使用手冊_消息服務-阿裏雲
  下一篇:go Notification操作__主題接口規範_API使用手冊_消息服務-阿裏雲