Description

Send a composite message

Request Specification

Method: POST + application/json

Endpoint: https://${Cloud Domain}/cgi/message/send?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
toUser	List	Yes	Open platform employee ID list (message recipients, currently supports up to 500 users)
msgType	String	Yes	Message type, value: composite
composite	Object	Yes	Secondary object, text data details
composite.head.title	String	Yes	Header title
composite.first.content	String	No	Content title
composite.form	List	No	Content list
composite.form.label	String	No	List label
composite.form.value	String	No	List value
composite.remark.content	String	No	Content summary
composite.link.title	String	Yes	Link title for message click-through
composite.link.url	String	Yes	Link URL for message click-through. Supports Fxiaoke internal jump address format: fs://CRM/udobj?{"objDescApiName":"AccountObj","objDataId":"5ff2780b7132bb0001bade16"}

Request Example

{
   "toUser":[
    "TOUSER1",
    "TOUSER2"
   ],
   "msgType":"composite",
   "composite":{
      "head":{
         "title":"Operation Daily Report"
      },
      "first":{
         "content":"Red Packet Data"
      },
      "form":[
         {
            "label":"CRM (Daily Clicks)",
            "value":"100000"
         },
         {
            "label":"Meeting Assistant (Daily Clicks)",
            "value":"200000"
         },
         {
            "label":"CRM (Daily Clicks)",
            "value":"300000"
         },
         {
            "label":"PK Assistant (Daily Clicks)",
            "value":"400000"
         }
      ],
      "remark":{
         "content":"remark"
      },
      "link":{
         "title":"Details",
         "url":"http://www.fxiaoke.com"
      }
   }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes Reference

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgment as errorMessage may change;