Secure Messaging API v8.12.2.0

<back to all web services

SendMessage

The following routes are available for this service:
PUT/api/v1/messages/{MessageGuid}/sendAllows the user to send a draft message.
PUT/api/messages/{MessageGuid}/send
SendMessage Parameters:
NameParameterData TypeRequiredDescription
MessageGuidpathstringYes
PasswordbodystringYesThe password for the message, if required.
InviteNewUsersbodybool?NoRecipients of the message that do not exist in the service will be invited.

Allowable Values

  • true
  • false
SendEmailNotificationbodybool?NoRequire the service to send a basic email notification message.

Allowable Values

  • true
  • false
CraCodebodystringNo
NotificationFormatsbodyarrayNo

Allowable Values

  • Text
  • Html
SendMessageResponse Parameters:
NameParameterData TypeRequiredDescription
NotificationBodyTextformstringNo
NotificationBodyHtmlformstringNo
NotificationSentformboolNo

Allowable Values

  • true
  • false
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

Error Codes:

Http Error Code: Unauthorized (401) - System Error Code: Unauthorized 811 - The user session is no longer valid.
Http Error Code: NotFound (404) - System Error Code: NotFound 929 - Message not found
Http Error Code: Forbidden (403) - System Error Code: Forbidden 915 - The message has been recalled. 17 - This secure message cannot be sent because it contains the keywords or strings that are banned. 30 - Error to invite new users to the Secure Messaging Platform 74 - Message recipients limit reached. 44 - CRA Input required to send this message to this user 45 - CRA Input required to send this message to multiple users 38 - Incorrect For Your Eyes Only password. 49 - Your package does not allow you to send to members in your contact list. 28 - You have sent all of your allowed daily secure messages. Please contact the administrator to upgrade your User Group profile. 8871 - You are trying to send a secure message to one or more Users that are disabled. 51 - You must pass FYEO message password. 922 - This user doesn't have access to FYEO. 930 - This user doesn't have access to Confidential. 75 - Message Expiry is disabled. You cannot set an expiry date. 76 - Message Expiry is invalid. 909 - You cannot forward to this message. 908 - You cannot reply to this message. 77 - You cannot reply to this message.

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/SendMessage HTTP/1.1 
Host: cirius10.secure-messaging.com 
Content-Type: application/json
Content-Length: length

{"messageGuid":"00000000000000000000000000000000","password":"String","inviteNewUsers":false,"sendEmailNotification":false,"craCode":"String","notificationFormats":["String"]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"notificationBodyText":"String","notificationBodyHtml":"String","notificationSent":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}