Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

1. Conventions, restrictions and assumptions

JIRA has FeiShu for Jira plug-in, and has completed the Mobile configuration, User Binding Configuration.

2. Interface document

(1) Function description

According to the parameters passed in by the caller, a message notification is sent to the corresponding enterprise FeiShu users.

(2) Call description

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",    

 "issueKey":"Test-1 "

}

Mandatory Field:

userKey、title、content

Parameter description

  1. userKey: A collection, unique identity of JIRA users(Note: User Key is not User ID).

  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).

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

 

(3) Message Return

Example of message return format:

{"code": "00000", "msg": "sent successfully"}

 

The returned content is a string, the format is JSON, UTF-8 encoding. Including code and msg.

 

code is message code, msg is message content.

 

Please refer to the following for specific message return : 4. Message code and message content list.

3. Logging

Every request message received by the interface will be recorded in JIRA log, which is convenient for debugging and troubleshooting in the later stage.

All errors and exceptions are recorded in atlassian-jira.log (jira application log),catalina.out (jira tomcat log).

 

4. Message code and message content list

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

90005

Illegal parameter title

90007

The configuration of plug-in Feishu for Jira is wrong

90008

This is no request header in Headers

90011

Please setting APP(Mobile Configuration) first.

 

  • No labels