Send Binary Message (Non-Queued) API
Available in PIT v2.3
This ILE API wraps the Send Binary Message Web Service. See its documentation for a further explanation of the input and output parameters as well as the possible error conditions.
Note that this API does NOT use the forward message queueing approach. This API calls the web service immediately.
API Name: QTBINMSG
Parameter Interface:
|
Parameter
|
Direction
|
Type
|
Length
|
Precision
|
Description
|
|---|---|---|---|---|---|
|
Destinations |
Input |
Character |
339 |
n/a |
|
|
Return Receipt? |
Input |
Character |
10 |
n/a |
Return receipt requests: "true" or "false" |
|
Priority |
Input |
Character |
1 |
n/a |
|
|
GMH |
Output |
Character |
20 |
n/a |
GMH of the binary message that was created |
|
Virtual Channel |
Input |
Character |
5 |
n/a |
|
|
Binary Message Length |
Input |
Character |
5 |
n/a |
Number of bytes of binary message data to be sent up to 4,000 bytes max. |
|
Binary Message Body |
Input |
Character |
65535 |
n/a |
Binary message data up to 4,000 bytes in length. There is no need to pre-encode the data to Base64. |
|
Output |
Decimal |
3 |
0 |
Error Category, if any |
|
|
Output |
Decimal |
5 |
0 |
Error Code, if any |
|
|
Output |
Character |
150 varying |
n/a |
Error description, if any |
An error category of 0 means that the message has been sent, and the GMH field is properly filled.