Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request type

POST

Request address

{jira_base_url}/rest/feiShu-jira/2/message/sendMessage

Media Type

application/json

Request Header

noticeToken: xxxxxx

Required.

noticeToken is a security token that other plug-ins or third-party services must provide when calling this API.Please refer to the following for details.

Auth

Anonymous interface does not require Auth.Judge whether the call is legal through noticeToken passed from headers.

Body

Transfer body in JSON format.

 

{     

"userKey":["JIRAUSER10100", "JIRAUSER19625"],    

 "mode":"0",    

 "title":"XXX is due",     

"content":"XXX is due, please deal with it as soon as possible",    

 "urlissueKey":"https://www.xxx.com Test-1 "

} 

Mandatory Field:

userKey、mode、title、content、url(Only card type is required)userKey、title、content

Parameter description

  1. userKey: A collection, unique identity of JIRA users(Note: User Key is not User ID).mode: Ways of enterprise FeiShu message notification(Integer type:1 is text, 0 is card).

  2. title: Message title(String type; No more than 128 bytes, more than interception).

  3. content: Message content(String type;HTML tags need stitching, no more than 512 bytes, more than interception).url: Click the card message and jump to the URL of the details page(String type; Make sure the protocol header is included(http/https)).Non card message type value can be

  4. empty.issueKey: Can be empty. If it is empty, the message will not contain problem information.

 

(3) Message Return

Example of message return format:

...

Illegal parameter content

Message code

Message content(English)

00000

Sent successfully

90000

Illegal parameter construction

90001

Invalid license for FeiShu for Jira plug-in

90002

noticeToken is illegal

90003

The user does not exist or is not bound to the enterprise FeiShu user

90004

Illegal parameter mode

90005

Illegal parameter title

90006

The url can’t be empty when the sending format is card

90007

The configuration of plug-in Feishu for Jira is wrong

90008

This is no request header in Headers

90009

90011

Please setting APP(Mobile Configuration) first.