API Reference - Revision history

PeterSurda: Fix: sendMessage/sendBroadcast if using TTL, you also need encodingtype

2017-05-27T05:51:01Z

Fix: sendMessage/sendBroadcast if using TTL, you also need encodingtype

Atheros: /* List of Operations */ Added TTL to sendBroadcast

2015-03-07T07:37:03Z

List of Operations: Added TTL to sendBroadcast

Atheros: /* List of Operations */ Added TTL to sendMessage

2015-03-07T07:24:33Z

List of Operations: Added TTL to sendMessage

Atheros: /* List of Operations */

2014-12-26T04:01:32Z

List of Operations

Atheros: /* List of Operations */ Added clientStatus. This was implemented in August 2013.

2014-12-26T04:00:37Z

List of Operations: Added clientStatus. This was implemented in August 2013.

Atheros: /* List of Operations */ Added addAddressToBlackWhiteList and removeAddressFromBlackWhiteList

2014-12-26T03:11:37Z

List of Operations: Added addAddressToBlackWhiteList and removeAddressFromBlackWhiteList

Atheros: /* Possible error values */ Added 28 and 29

2014-12-26T03:03:41Z

Possible error values: Added 28 and 29

Atheros: API Error 0027: Message is too long.

2014-08-27T20:09:35Z

API Error 0027: Message is too long.

Atheros: /* Possible error values */ Added API Error 0026: Varint encoded in address is malformed.

2014-08-25T21:00:41Z

Possible error values: Added API Error 0026: Varint encoded in address is malformed.

JonathanCoe: Clarified the example of api data in keys.dat file

2014-05-21T11:17:27Z

Clarified the example of api data in keys.dat file

@@ Line 149: / Line 149: @@
 | trashMessage || <msgid> || 0.2.7 || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.
 |-
-| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] [TTL] || 0.2.7 or 0.4.5 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
+| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType [TTL]] || 0.2.7 or 0.4.5 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
 |-
-| sendBroadcast || <fromAddress> <subject> <message> [encodingType] [TTL] || 0.2.7 or 0.4.5 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
+| sendBroadcast || <fromAddress> <subject> <message> [encodingType [TTL]] || 0.2.7 or 0.4.5 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
 |-
 | getStatus || <ackData> || 0.3.0 || returns one of these strings: <strike>notFound, findingPubkey, doingPOW, sentMessage, or ackReceived</strike> notfound, msgqueued, broadcastqueued, broadcastsent, doingpubkeypow, awaitingpubkey, doingmsgpow, forcepow, msgsent, msgsentnoackexpected, or ackreceived.

@@ Line 149: / Line 149: @@
 | trashMessage || <msgid> || 0.2.7 || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.
 |-
-| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] [TTL] || 0.2.7 - 0.4.5 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
+| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] [TTL] || 0.2.7 or 0.4.5 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
 |-
-| sendBroadcast || <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility.
+| sendBroadcast || <fromAddress> <subject> <message> [encodingType] [TTL] || 0.2.7 or 0.4.5 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
 |-
 | getStatus || <ackData> || 0.3.0 || returns one of these strings: <strike>notFound, findingPubkey, doingPOW, sentMessage, or ackReceived</strike> notfound, msgqueued, broadcastqueued, broadcastsent, doingpubkeypow, awaitingpubkey, doingmsgpow, forcepow, msgsent, msgsentnoackexpected, or ackreceived.

@@ Line 149: / Line 149: @@
 | trashMessage || <msgid> || 0.2.7 || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.
 |-
-| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility.
+| sendMessage || <toAddress> <fromAddress> <subject> <message> [encodingType] [TTL] || 0.2.7 - 0.4.5 || returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility. TTL is specified in seconds; values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. TTL defaults to 4 days. TTL is only available in PyBitmessage version 0.4.5 and higher.
 |-
 | sendBroadcast || <fromAddress> <subject> <message> [encodingType] || 0.2.7 || returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility.

@@ Line 192: / Line 192: @@
 | removeAddressFromBlackWhiteList || <address> || 0.4.5 || Delete an entry from your black or white list- whichever you are currently using (but not both).
 |-
-| clientStatus ||  || 0.3.5 || Returns the softwareName, softwareVersion, networkStatus, networkConnections, numberOfPubkeysProcessed, numberOfMessagesProcessed, and numberOfBroadcastsProcessed. networkStatus will be one of these strings: "notConnected", "connectedButHaveNotReceivedIncomingConnections", or "connectedAndReceivingIncomingConnections".
+| clientStatus ||  || 0.4.0 || Returns the softwareName, softwareVersion, networkStatus, networkConnections, numberOfPubkeysProcessed, numberOfMessagesProcessed, and numberOfBroadcastsProcessed. networkStatus will be one of these strings: "notConnected", "connectedButHaveNotReceivedIncomingConnections", or "connectedAndReceivingIncomingConnections".
 |}

@@ Line 191: / Line 191: @@
 |-
 | removeAddressFromBlackWhiteList || <address> || 0.4.5 || Delete an entry from your black or white list- whichever you are currently using (but not both).
 |}

@@ Line 187: / Line 187: @@
 * streamNumber (ascii integer)
 * ripe (base64, decodes into binary data)
 |}

@@ Line 253: / Line 253: @@
 |-
 | 0027 || API Error 0027: Message is too long.
 |}

@@ Line 251: / Line 251: @@
 |-
 | 0026 || API Error 0026: Varint encoded in address is malformed.
 |}

@@ Line 249: / Line 249: @@
 |-
 | 0025 || API Error 0025: Specified address is not a chan address. Use deleteAddress API call instead.
 |}

@@ Line 4: / Line 4: @@
 === Enable the API ===
-To enable the API, copy and paste these lines into the bitmessagesettings section of the [[keys.dat]] file (the values "username" and "password" are merely examples):
+To enable the API, copy and paste these lines into the bitmessagesettings section of the [[keys.dat]] file.
 <pre>
 apienabled = true
 apiport = 8442
 apiinterface = 127.0.0.1
-apiusername = chelsea
+apiusername = username
-apipassword = YourSuperPassw6rd-ChangeThIs-022w3eksssoQAWfasddswwWIU
+apipassword = password
 </pre>
 Additionally, you may optionally include an additional entry which will specify a program which Bitmessage will run when certain events occur.